#include <SceneItem.h>

Inheritance diagram for cnoid::SceneItem:

Public Member Functions
	SceneItem ()

	SceneItem (const SceneItem &org)

virtual	~SceneItem ()

virtual bool	setName (const std::string &name) override

virtual SgNode *	getScene () override

SgPosTransform *	topNode ()

const SgPosTransform *	topNode () const

void	setTranslation (const Vector3 &translation)

void	setRotation (const AngleAxis &rotation)

void	setTranslation (const Vector3f &translation)

void	setRotation (const AngleAxisf &rotation)

void	setLightweightRenderingEnabled (bool on)

bool	isLightweightRenderingEnabled () const

Public Member Functions inherited from cnoid::Item
virtual	~Item ()

Item &	operator= (const Item &rhs)=delete

int	classId () const

Item *	createNewInstance () const

void	assign (Item *srcItem)
	Copy item properties as much as possible like the assignment operator. More...

Item *	duplicate (Item *duplicatedParentItem=nullptr) const

Item *	duplicateSubTree () const
	This function creates a copy of the item including its descendant items. More...

Item *	duplicateAll () const

const std::string &	name () const

virtual std::string	displayName () const

void	setDisplayNameModifier (std::function< std::string(const Item *item)> modifier)

SignalProxy< void(const std::string &oldName)>	sigNameChanged ()

void	notifyNameChange ()
	This function notifies the system of a displayName change. More...

void	setAttribute (Attribute attribute)

void	unsetAttribute (Attribute attribute)

bool	hasAttribute (Attribute attribute) const

bool	isSubItem () const

void	setSubItemAttributes ()

bool	isTemporal () const

void	setTemporal (bool on=true)

bool	isSelected () const

void	setSelected (bool on, bool isCurrent=false)

void	setSubTreeItemsSelected (bool on)

bool	isChecked (int checkId=PrimaryCheck) const

void	setChecked (bool on)

void	setChecked (int checkId, bool on)

int	numCheckStates () const

int	numChildren () const

int	countDescendantItems () const

Item *	childItem () const

Item *	prevItem () const

Item *	nextItem () const

Item *	lastChildItem () const

Item *	parentItem () const

Item *	headItem () const

RootItem *	findRootItem () const

bool	isConnectedToRoot () const

Item *	localRootItem () const

bool	addChildItem (Item *item, bool isManualOperation=false)

bool	insertChildItem (Item item, Item nextItem, bool isManualOperation=false)

bool	insertChild (Item position, Item item, bool isManualOperation=false)

bool	addSubItem (Item *item)

bool	insertSubItem (Item item, Item nextItem)

void	removeFromParentItem ()

void	detachFromParentItem ()

void	clearChildren ()

template<class ItemType >
ItemType *	find (const std::string &path="")

Item *	findItem (const std::string &path) const

template<class ItemType >
ItemType *	findItem (const std::string &path) const

template<class ItemType >
ItemType *	findItem (std::function< bool(ItemType *item)> pred=nullptr) const

Item *	findChildItem (const std::string &path, std::function< bool(Item *item)> pred=nullptr) const

template<class ItemType >
ItemType *	findChildItem (const std::string &path, std::function< bool(ItemType *item)> pred=nullptr) const

template<class ItemType >
ItemType *	findChildItem (std::function< bool(ItemType *item)> pred=nullptr) const

Item *	findSubItem (const std::string &path) const

template<class ItemType >
ItemType *	findSubItem (const std::string &path="") const

template<class ItemType >
ItemType *	findOwnerItem (bool includeSelf=false) const

bool	isOwnedBy (Item *item) const

ItemList	childItems (std::function< bool(Item *item)> pred=nullptr) const

template<class ItemType >
ItemList< ItemType >	childItems (std::function< bool(ItemType *item)> pred=nullptr) const

ItemList	descendantItems (std::function< bool(Item *item)> pred=nullptr) const

template<class ItemType >
ItemList< ItemType >	descendantItems (std::function< bool(ItemType *item)> pred=nullptr) const

ItemList	selectedDescendantItems (std::function< bool(Item *item)> pred=nullptr) const

template<class ItemType >
ItemList< ItemType >	selectedDescendantItems (std::function< bool(Item *item)> pred=nullptr) const

bool	traverse (std::function< bool(Item *)> pred)

template<class ItemType >
bool	traverse (std::function< bool(ItemType *item)> pred=nullptr)

SignalProxy< void()>	sigTreePathChanged ()

SignalProxy< void()>	sigTreePositionChanged ()

SignalProxy< void(Item topItem, Item prevTopParentItem)>	sigTreePositionChanged2 ()

SignalProxy< void()>	sigPositionChanged ()

SignalProxy< void()>	sigSubTreeChanged ()

SignalProxy< void()>	sigDisconnectedFromRoot ()

SignalProxy< void()>	sigDetachedFromRoot ()

SignalProxy< void(bool on)>	sigSelectionChanged ()

SignalProxy< void(int checkId, bool on)>	sigAnyCheckToggled ()

SignalProxy< void(bool on)>	sigCheckToggled (int checkId=PrimaryCheck)

virtual void	notifyUpdate ()

SignalProxy< void()>	sigUpdated ()

bool	setAddon (ItemAddon *addon)

void	removeAddon (ItemAddon *addon)

template<class AddonType >
AddonType *	findAddon ()

template<class AddonType >
AddonType *	getAddon ()

std::vector< ItemAddon * >	addons ()

bool	load (const std::string &filename, const std::string &format=std::string(), const Mapping *options=nullptr)

bool	load (const std::string &filename, Item parent, const std::string &format=std::string(), const Mapping options=nullptr)

bool	save (const std::string &filename, const std::string &format=std::string(), const Mapping *options=nullptr)

bool	overwrite (bool forceOverwrite=false, const std::string &format=std::string())

const std::string &	filePath () const
	Full path file name. More...

std::string	fileName () const
	File name without the directory. More...

const std::string &	fileFormat () const

const Mapping *	fileOptions () const

std::time_t	fileModificationTime () const

bool	isConsistentWithFile () const

void	updateFileInformation (const std::string &filename, const std::string &format, Mapping *options=nullptr)

void	setConsistentWithFile (bool isConsistent)

void	suggestFileUpdate ()

void	clearFileInformation ()
	Use this function to disable the implicit overwrite next time. More...

bool	reload ()

bool	replace (Item *originalItem)

Item *	findOriginalItem () const

Item *	findReplacementItem () const

void	putProperties (PutPropertyFunction &putProperty)

Public Member Functions inherited from cnoid::Referenced
virtual	~Referenced ()

Public Member Functions inherited from cnoid::RenderableItem
	RenderableItem ()

virtual	~RenderableItem ()

virtual bool	isSceneSensitive ()

virtual void	setSceneSensitive (bool on)

virtual SignalProxy< void(bool on)>	sigSceneSensitiveChanged ()

Static Public Member Functions
static void	initializeClass (ExtensionManager *ext)

static void	registerSceneItemFileIoSet (ItemManager *im)

static ItemFileIO *	stdSceneFileExporter ()

Static Public Member Functions inherited from cnoid::Item
template<class ItemType >
static ItemPredicate	getItemPredicate ()

template<class ItemType >
static ItemPredicate	getItemPredicate (std::function< bool(ItemType *item)> pred)

static Item *	find (const std::string &path)

Protected Member Functions
virtual Item *	doDuplicate () const override
	Override this function to allow duplication of an instance. More...

virtual bool	store (Archive &archive) override

virtual bool	restore (const Archive &archive) override

virtual void	doPutProperties (PutPropertyFunction &putProperty) override

Protected Member Functions inherited from cnoid::Item
	Item ()

	Item (const std::string &name)

	Item (const Item &item)

virtual void	doAssign (Item *srcItem)
	Implement the code to copy properties like the assingment operator. More...

virtual Item *	doDuplicate (Item *duplicatedParentItem) const

virtual bool	onNewTreePositionCheck (bool isManualOperation, std::function< void()> &out_callbackWhenAdded)

virtual void	onAddedToParent ()

virtual void	onTreePathChanged ()

virtual void	onTreePositionChanged ()

virtual void	onPositionChanged ()

virtual void	onConnectedToRoot ()

virtual void	onRemovedFromParent (Item *parentItem, bool isParentBeingDeleted)

virtual void	onDisconnectedFromRoot ()

virtual bool	onChildItemAboutToBeAdded (Item *childItem, bool isManualOperation)

Protected Member Functions inherited from cnoid::Referenced
	Referenced ()

	Referenced (const Referenced &)

int	refCount () const

Additional Inherited Members
Public Types inherited from cnoid::Item
enum	Attribute { SubItem, Attached, Temporal, LoadOnly, NumAttributes, SUB_ITEM = SubItem, TEMPORAL = Temporal, LOAD_ONLY = LoadOnly }

enum	CheckId { LogicalSumOfAllChecks = -1, PrimaryCheck = 0 }

typedef std::function< bool(Item *item)>	ItemPredicate

Constructor & Destructor Documentation

◆ SceneItem() [1/2]

SceneItem::SceneItem ( )

◆ SceneItem() [2/2]

SceneItem::SceneItem ( const SceneItem & org )

◆ ~SceneItem()

SceneItem::~SceneItem ( )

virtual

Member Function Documentation

◆ doDuplicate()

Item * SceneItem::doDuplicate ( ) const

overrideprotectedvirtual

Override this function to allow duplication of an instance.

Reimplemented from cnoid::Item.

◆ doPutProperties()

void SceneItem::doPutProperties ( PutPropertyFunction & putProperty )

overrideprotectedvirtual

This function is used to put a standard properties of the item. You can implement the standard properties by overriding this function.

Note: The overridden function should call the same function of the parent class.

Reimplemented from cnoid::Item.

◆ getScene()

SgNode * SceneItem::getScene ( )

overridevirtual

Implements cnoid::RenderableItem.

◆ initializeClass()

void SceneItem::initializeClass ( ExtensionManager * ext )

static

◆ isLightweightRenderingEnabled()

bool cnoid::SceneItem::isLightweightRenderingEnabled ( ) const

inline

◆ registerSceneItemFileIoSet()

void SceneItem::registerSceneItemFileIoSet ( ItemManager * im )

static

◆ restore()

bool SceneItem::restore ( const Archive & archive )

overrideprotectedvirtual

Reimplemented from cnoid::Item.

◆ setLightweightRenderingEnabled()

void SceneItem::setLightweightRenderingEnabled ( bool on )

◆ setName()

bool SceneItem::setName ( const std::string & name )

overridevirtual

Returns: true if the name is successfully updated or the item originally has the same name

Reimplemented from cnoid::Item.

◆ setRotation() [1/2]

void SceneItem::setRotation ( const AngleAxis & rotation )

◆ setRotation() [2/2]

void SceneItem::setRotation ( const AngleAxisf & rotation )

◆ setTranslation() [1/2]

void SceneItem::setTranslation ( const Vector3 & translation )

◆ setTranslation() [2/2]

void SceneItem::setTranslation ( const Vector3f & translation )

◆ stdSceneFileExporter()

ItemFileIO * SceneItem::stdSceneFileExporter ( )

static

◆ store()

bool SceneItem::store ( Archive & archive )

overrideprotectedvirtual

Reimplemented from cnoid::Item.

◆ topNode() [1/2]

SgPosTransform* cnoid::SceneItem::topNode ( )

inline

◆ topNode() [2/2]

const SgPosTransform* cnoid::SceneItem::topNode ( ) const

inline

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ SceneItem() [1/2]

◆ SceneItem() [2/2]

◆ ~SceneItem()

Member Function Documentation

◆ doDuplicate()

◆ doPutProperties()

◆ getScene()

◆ initializeClass()

◆ isLightweightRenderingEnabled()

◆ registerSceneItemFileIoSet()

◆ restore()

◆ setLightweightRenderingEnabled()

◆ setName()

◆ setRotation() [1/2]

◆ setRotation() [2/2]

◆ setTranslation() [1/2]

◆ setTranslation() [2/2]

◆ stdSceneFileExporter()

◆ store()

◆ topNode() [1/2]

◆ topNode() [2/2]