Choreonoid  1.5
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
cnoid::WorldItem Class Reference

#include <WorldItem.h>

Inheritance diagram for cnoid::WorldItem:
cnoid::Item cnoid::SceneProvider cnoid::Referenced

Public Member Functions

 WorldItem ()
 
 WorldItem (const WorldItem &org)
 
virtual ~WorldItem ()
 
const ItemList< BodyItem > & collisionBodyItems () const
 
bool selectCollisionDetector (const std::string &name)
 
CollisionDetectorPtr collisionDetector ()
 
void enableCollisionDetection (bool on)
 
bool isCollisionDetectionEnabled ()
 
void updateCollisionDetectorLater ()
 
void updateCollisionDetector ()
 
void updateCollisions ()
 
std::vector< CollisionLinkPairPtr > & collisions () const
 
SignalProxy< void()> sigCollisionsUpdated ()
 
virtual SgNodegetScene ()
 
- Public Member Functions inherited from cnoid::Item
virtual ~Item ()
 
const std::string & name () const
 
virtual void setName (const std::string &name)
 
bool hasAttribute (Attribute attribute) const
 
ItemchildItem () const
 
ItemprevItem () const
 
ItemnextItem () const
 
ItemparentItem () const
 
bool addChildItem (Item *item, bool isManualOperation=false)
 
bool addSubItem (Item *item)
 
bool isSubItem () const
 
void detachFromParentItem ()
 
void emitSigDetachedFromRootForSubTree ()
 
bool insertChildItem (Item *item, Item *nextItem, bool isManualOperation=false)
 
bool insertSubItem (Item *item, Item *nextItem)
 
bool isTemporal () const
 
void setTemporal (bool on=true)
 
RootItemfindRootItem () const
 
ItemfindItem (const std::string &path) const
 
template<class ItemType >
ItemType * findItem (const std::string &path) const
 
template<class ItemType >
ItemType * find (const std::string &path)
 
ItemfindChildItem (const std::string &path) const
 
template<class ItemType >
ItemType * findChildItem (const std::string &path) const
 
ItemfindSubItem (const std::string &path) const
 
template<class ItemType >
ItemType * findSubItem (const std::string &path) const
 
ItemheadItem () const
 
template<class ItemType >
ItemType * findOwnerItem (bool includeSelf=false)
 
bool isOwnedBy (Item *item) const
 
bool traverse (boost::function< bool(Item *)> function)
 
template<class ItemType >
bool traverse (boost::function< bool(ItemType *item)> function)
 
Itemduplicate () const
 
ItemduplicateAll () const
 
void assign (Item *srcItem)
 
bool load (const std::string &filename, const std::string &format=std::string())
 
bool load (const std::string &filename, Item *parent, const std::string &format=std::string())
 
bool save (const std::string &filename, const std::string &format=std::string())
 
bool overwrite (bool forceOverwrite=false, const std::string &format=std::string())
 
const std::string & filePath () const
 
const std::string & fileFormat () const
 
std::time_t fileModificationTime () const
 
bool isConsistentWithFile () const
 
void clearFileInformation ()
 
void suggestFileUpdate ()
 
void putProperties (PutPropertyFunction &putProperty)
 
virtual void notifyUpdate ()
 
SignalProxy< void(const std::string &oldName)> sigNameChanged ()
 
SignalProxy< void()> sigUpdated ()
 
SignalProxy< void()> sigPositionChanged ()
 
SignalProxy< void()> sigDetachedFromRoot ()
 
SignalProxy< void()> sigDisconnectedFromRoot ()
 
SignalProxy< void()> sigSubTreeChanged ()
 
ReferencedcustomData (int id)
 
const ReferencedcustomData (int id) const
 
void setCustomData (int id, ReferencedPtr data)
 
void clearCustomData (int id)
 
- Public Member Functions inherited from cnoid::Referenced
virtual ~Referenced ()
 
void addRef ()
 
void releaseRef ()
 
- Public Member Functions inherited from cnoid::SceneProvider
virtual ~SceneProvider ()
 
virtual SgNodegetScene (SgCloneMap &cloneMap)
 

Static Public Member Functions

static void initializeClass (ExtensionManager *ext)
 
- Static Public Member Functions inherited from cnoid::Item
static Itemfind (const std::string &path)
 
static SignalProxy< void(const char *type_info_name)> sigClassUnregistered ()
 

Protected Member Functions

virtual ItemdoDuplicate () const
 
virtual void doPutProperties (PutPropertyFunction &putProperty)
 
virtual bool store (Archive &archive)
 
virtual bool restore (const Archive &archive)
 
- Protected Member Functions inherited from cnoid::Item
 Item ()
 
 Item (const Item &item)
 
virtual void onConnectedToRoot ()
 
virtual void onDisconnectedFromRoot ()
 
virtual void onPositionChanged ()
 
virtual bool onChildItemAboutToBeAdded (Item *childItem, bool isManualOperation)
 
virtual void doAssign (Item *srcItem)
 
void setAttribute (Attribute attribute)
 
void unsetAttribute (Attribute attribute)
 
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &org)
 
int refCount () const
 

Additional Inherited Members

- Public Types inherited from cnoid::Item
enum  Attribute { SUB_ITEM, TEMPORAL, LOAD_ONLY, NUM_ATTRIBUTES }
 

Constructor & Destructor Documentation

◆ WorldItem() [1/2]

WorldItem::WorldItem ( )

◆ WorldItem() [2/2]

WorldItem::WorldItem ( const WorldItem org)

◆ ~WorldItem()

WorldItem::~WorldItem ( )
virtual

Member Function Documentation

◆ collisionBodyItems()

const ItemList< BodyItem > & WorldItem::collisionBodyItems ( ) const

◆ collisionDetector()

CollisionDetectorPtr WorldItem::collisionDetector ( )

◆ collisions()

std::vector< CollisionLinkPairPtr > & WorldItem::collisions ( ) const

◆ doDuplicate()

Item * WorldItem::doDuplicate ( ) const
protectedvirtual

Override this function to allow duplication of an instance.

Reimplemented from cnoid::Item.

◆ doPutProperties()

void WorldItem::doPutProperties ( PutPropertyFunction putProperty)
protectedvirtual

Override this function to put properties of the item.

Note
Please call doPutProperties() of the parent class in this function. For example, when your class directly inherits the Item class, call Item::doPutProperties(putProperty).

Reimplemented from cnoid::Item.

◆ enableCollisionDetection()

void WorldItem::enableCollisionDetection ( bool  on)

◆ getScene()

SgNode * WorldItem::getScene ( )
virtual

If the scene has some state that affect the rendering, the scene node should be cloned for each call of this function. Otherwise, the same instance can be returned.

Implements cnoid::SceneProvider.

◆ initializeClass()

void WorldItem::initializeClass ( ExtensionManager ext)
static

◆ isCollisionDetectionEnabled()

bool WorldItem::isCollisionDetectionEnabled ( )

◆ restore()

bool WorldItem::restore ( const Archive archive)
protectedvirtual

Reimplemented from cnoid::Item.

◆ selectCollisionDetector()

bool WorldItem::selectCollisionDetector ( const std::string &  name)

◆ sigCollisionsUpdated()

SignalProxy< void()> WorldItem::sigCollisionsUpdated ( )

◆ store()

bool WorldItem::store ( Archive archive)
protectedvirtual

Reimplemented from cnoid::Item.

◆ updateCollisionDetector()

void WorldItem::updateCollisionDetector ( )

◆ updateCollisionDetectorLater()

void WorldItem::updateCollisionDetectorLater ( )

◆ updateCollisions()

void WorldItem::updateCollisions ( )

The documentation for this class was generated from the following files: