Class SBDDocumentFolder

ClassList > SBDDocumentFolder

This class describes a document folder. More...

• #include <SBDDocumentFolder.hpp>

Inherits the following classes: SBDDataGraphNode

Inherited by the following classes: SBDDocument

Public Types inherited from SBDDataGraphNode

See SBDDataGraphNode

Type	Name
enum	RenderingPass The rendering pass.
enum	Type The type of the data graph node.

Public Functions

Type	Name
	SBDDocumentFolder () Constructs a folder.
	SBDDocumentFolder (const std::string & name) Constructs a folder with name name .
virtual bool	addChild (SBNode * node, SBNode * nextNode=nullptr) override Adds a child to the folder.
virtual bool	canAddChild (const SBNode * node, const SBNode * nextNode=nullptr) override const Returns whether this node can add node as a child.
virtual bool	canAddChildType (SBNode::Type nodeType) override const Returns whether this node can add a node with type nodeType as a child.
virtual bool	canHaveDescendantType (SBNode::Type nodeType) override const Returns whether this node can have a node with type nodeType as a descendant.
virtual SBDDocumentFolder *	clone () override Returns a copy of the node and its descendants.
void	connectDocumentSignalToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBDocumentEvent *) functionPointer, SBCReferenceTarget * nextReferenceTarget=0, void(SBCReferenceTarget::*)(SBDocumentEvent *) nextFunctionPointer=0) Connects the document signal to a slot.
void	disconnectDocumentSignalFromSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBDocumentEvent *) functionPointer) Disconnects the document signal from a slot.
bool	documentSignalIsConnectedToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBDocumentEvent *) functionPointer) const Returns true if and only if the document signal is connected to the slot.
virtual void	forEachNodeDepthFirst (void(*)(SBNode *node) action) override Performs the action on each node of this folder (the folder itself and its children), depth-first.
virtual void	forEachNodeDepthFirst (SBCClass * object, void(SBCClass::*)(SBNode *node) action) override Performs the object 'saction on each node of this folder (the folder itself and its children), depth-first.
SBPointerList< SBAnimation > const *	getAnimationList () const Returns the list of animations.
SBPointerList< SBAsset > const *	getAssetList () const Returns the list of assets.
SBPointerList< SBCamera > const *	getCameraList () const Returns the list of cameras.
SBPointerList< SBNode > const *	getChildren () const Returns the children of the folder.
SBPointerList< SBConformation > const *	getConformationList () const Returns the list of conformations.
SBPointerList< SBDController > const *	getControllerList () const Returns the list of controllers.
SBPointerList< SBMDynamicalModel > const *	getDynamicalModelList () const Returns the list of dynamical models.
SBPointerList< SBFile > const *	getFileList () const Returns the list of files.
SBPointerList< SBDDocumentFolder > const *	getFolderList () const Returns the list of folders.
SBPointerList< SBMInteractionModel > const *	getInteractionModelList () const Returns the list of interaction models.
SBPointerList< SBLabel > const *	getLabelList () const Returns the list of labels.
SBPointerList< SBLight > const *	getLightList () const Returns the list of lights.
SBPointerList< SBMModel > const *	getModelList () const Returns the list of models.
virtual SBQuantity::mass	getMolecularWeight () override Returns the molecular weight.
SBDDocumentFolder *	getNextFolder () const Returns the next folder.
SBPointerList< SBNodeGroup > const *	getNodeGroupList () const Returns the list of node groups.
virtual void	getNodes (SBNodeIndexer & nodeIndexer, SBNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Collects nodes into nodeIndexer , based on anodeType , a selection status and avisitPredicate , with or without dependencies.
virtual void	getNodes (SBNodeIndexer & nodeIndexer, const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Collects nodes into nodeIndexer , based on aselectionPredicate and avisitPredicate , with or without dependencies.
SBPointerList< SBNote > const *	getNoteList () const Returns the list of notes.
virtual unsigned int	getNumberOfAtoms () override Returns the number of atoms.
virtual unsigned int	getNumberOfCarbons () override Returns the number of carbons.
virtual unsigned int	getNumberOfChains () override Returns the number of chains.
virtual unsigned int	getNumberOfCoarseGrainedAtoms () override Returns the number of coarse-grained atoms.
virtual unsigned int	getNumberOfHydrogens () override Returns the number of hydrogens.
virtual unsigned int	getNumberOfMolecules () override Returns the number of molecules.
virtual unsigned int	getNumberOfNitrogens () override Returns the number of nitrogens.
virtual unsigned int	getNumberOfOtherAtoms () override Returns the number of other atoms.
virtual unsigned int	getNumberOfOxygens () override Returns the number of oxygens.
virtual unsigned int	getNumberOfResidues () override Returns the number of residues.
virtual unsigned int	getNumberOfSegments () override Returns the number of segments.
virtual unsigned int	getNumberOfStructuralGroups () override Returns the number of structural groups.
virtual unsigned int	getNumberOfStructuralModels () override Returns the number of structural models.
virtual unsigned int	getNumberOfSulfurs () override Returns the number of sulfurs.
virtual unsigned int	getOpacity () override const Returns the opacity.
SBPointerList< SBPath > const *	getPathList () const Returns the list of paths.
SBPointerList< SBPresentation > const *	getPresentationList () const Returns the list of presentations.
SBDDocumentFolder *	getPreviousFolder () const Returns the previous folder.
SBPointerList< SBMPropertyModel > const *	getPropertyModelList () const Returns the list of property models.
SBPointerList< SBRenderPreset > const *	getRenderPresetList () const Returns the list of render presets.
SBPointerList< SBSSimulator > const *	getSimulatorList () const Returns the list of Simulators.
SBPointerList< SBMStructuralModel > const *	getStructuralModelList () const Returns the list of structural models.
virtual int	getSumOfFormalCharges () override Returns the sum of formal charges.
virtual float	getSumOfPartialCharges () override Returns the sum of partial charges.
virtual unsigned int	getTransparency () override const Returns the transparency.
virtual SBDDataGraphNode::Type	getType () override const Returns the data graph node type.
SBPointerList< SBMVisualModel > const *	getVisualModelList () const Returns the list of visual models.
virtual bool	hasNode (SBNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Checks for nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies.
virtual bool	hasNode (const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Checks for nodes based on a selectionPredicate and avisitPredicate , with or without dependencies.
virtual bool	initialize () Initializes the folder.
virtual bool	isSerializable () override const Returns true __
virtual void	print (unsigned int offset=0) override const Prints the folder.
virtual bool	removeChild (SBNode * node) override Removes a child from the folder.
virtual void	serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override const Serializes the folder.
virtual void	setOpacity (unsigned int opacity) override Sets the opacity.
virtual void	setTransparency (unsigned int transparency) override Sets the transparency.
virtual void	unserialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override Unserializes the folder.
virtual	~SBDDocumentFolder () Destructs the folder.

Public Functions inherited from SBDDataGraphNode

See SBDDataGraphNode

Type	Name
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBCClassProxy *, GetProxy)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, This)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetParent)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetThis)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetNextNode)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetPreviousNode)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDocument *, GetDocument)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetRoot)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, unsigned int, GetNodeIndex)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode::Type, GetType)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetSelectionFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetLockedFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetVisibilityFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetHighlightingFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, unsigned int, GetFlags)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, std::string, GetName)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, std::string, GetClass)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, std::string, GetElement)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBCContainerUUID, GetElementUUID)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, All)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, None)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsAtom)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsBond)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsStructuralNode)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsStructuralModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsVisualModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsMesh)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsLight)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsInteractionModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsDynamicalModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsPropertyModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSimulator)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsBallAndStick)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsLicorice)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsVanDerWaals)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsCartoon)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsRibbon)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsTube)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsGaussianSurface)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSolventAccessibleSurface)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSolventExcludedSurface)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, HasMaterial)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, OwnsMaterial)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsLocked)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSerializable)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsCreated)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsErased)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSelected)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsVisible)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsHighlighted)
	SB_NODE_PREDICATE_1 (SB_SBDDATAGRAPH_EXPORT, IsType, SBDDataGraphNode::Type)
	SB_NODE_PREDICATE_1 (SB_SBDDATAGRAPH_EXPORT, HasOneOf, SBNodeIndexer)
virtual bool	addChild (SBDDataGraphNode * node, SBDDataGraphNode * nextNode=nullptr) Adds a child to the node.
bool	addMaterial (SBDDataGraphNodeMaterial * material) Adds a material.
bool	baseSignalIsConnectedToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBBaseEvent *) functionPointer) const Returns true when the base signal is connected to a slot.
virtual bool	canAddChild (const SBDDataGraphNode * node, const SBDDataGraphNode * nextNode=nullptr) const Returns whether this node can add node as a child.
virtual bool	canAddChildType (SBDDataGraphNode::Type nodeType) const Returns whether this node can add a node with type nodeType as a child.
bool	canAddMaterial () const Returns whether can add a material to the node based on its type.
virtual bool	canHaveDescendantType (SBDDataGraphNode::Type nodeType) const Returns whether this node can have a node with type nodeType as a descendant.
virtual SBDDataGraphNode *	clone () Returns a copy of the node and its descendants.
void	connectBaseSignalToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBBaseEvent *) functionPointer, SBCReferenceTarget * nextReferenceTarget=0, void(SBCReferenceTarget::*)(SBBaseEvent *) nextFunctionPointer=0) Connects the base signal to a slot.
unsigned int	countNodes (SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Counts nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies.
unsigned int	countNodes (const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Counts nodes based on a selectionPredicate and avisitPredicate , with or without dependencies.
void	create () Creates the node.
bool	descendsFrom (const SBDDataGraphNode * node) const Returns true if and only if this node isnode , or descends from it.
bool	descendsFrom (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer , or descends from one of them.
bool	descendsFrom (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns true if and only if this node is one of the nodes of thenodePointerIndexer , or descends from one of them.
void	disconnectBaseSignalFromSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBBaseEvent *) functionPointer) Disconnects the base signal from a slot.
virtual void	display (RenderingPass renderingPass) Displays the node.
virtual void	display () Displays the node (deprecated)
virtual void	displayForSelection () Displays the node for selection purposes (deprecated)
virtual void	displayForShadow () Displays the node for shadowing purposes (deprecated)
void	erase () Erases the node.
virtual void	forEachNodeDepthFirst (void(*)(SBDDataGraphNode *node) action) Performs the action on this node.
virtual void	forEachNodeDepthFirst (SBCClass * object, void(SBCClass::*)(SBDDataGraphNode *node) action) Performs the objects 'saction on this node.
unsigned int	getDefaultOpacity () const Returns the default opacity.
unsigned int	getDefaultTransparency () const Returns the default transparency.
SBDDocument *	getDocument () const Returns the document the node belongs to.
virtual unsigned int	getFlags () const Returns the flags.
virtual std::string	getHierarchyString (const std::string & separator=" / ", bool includeNodeType=false) const Returns a string with hierarchical information on the node and its parents names.
bool	getHighlightingFlag () const Returns the highlighting flag.
virtual unsigned int	getInheritedFlags () const Returns the inherited flags.
float	getInheritedOpacity () const Returns the cumulative opacity, when taking into account the ascendants.
float	getInheritedTransparency () const Returns the cumulative transparency, when taking into account the ascendants.
virtual bool	getLockedFlag () const Returns the locked flag.
SBDDataGraphNodeMaterial *	getMaterial () const Returns the material.
SBDDataGraphNode *	getMaterialOwner () const Returns the node whose material is inherited.
unsigned int	getMaximumOpacity () const Returns the maximum opacity.
unsigned int	getMaximumTransparency () const Returns the maximum transparency.
unsigned int	getMinimumOpacity () const Returns the minimum opacity.
unsigned int	getMinimumTransparency () const Returns the minimum transparency.
virtual SBQuantity::mass	getMolecularWeight () Returns the molecular weight.
virtual std::string const &	getName () const Returns the name of the node.
SBDDataGraphNode *	getNextNode () const Returns the pointer to the next node in the children of the node's parent.
SBDDataGraphNode *	getNextNode (SBDDataGraphNode::Type nodeType) const Returns the pointer to the next node with type nodeType in the children of the node's parent.
unsigned int	getNodeIndex () const Returns the node index (unique in the whole data graph, but non-persistent)
SBUUID	getNodeUUID () const Returns the node UUID.
virtual void	getNodes (SBNodeIndexer & nodeIndexer, SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Collects nodes into nodeIndexer , based on anodeType , a selection status and avisitPredicate , with or without dependencies.
virtual void	getNodes (SBNodeIndexer & nodeIndexer, const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Collects nodes into nodeIndexer , based on aselectionPredicate and avisitPredicate , with or without dependencies.
virtual unsigned int	getNumberOfAtoms () Returns the number of atoms.
virtual unsigned int	getNumberOfCarbons () Returns the number of carbons.
virtual unsigned int	getNumberOfChains () Returns the number of chains.
virtual unsigned int	getNumberOfCoarseGrainedAtoms () Returns the number of coarse-grained atoms.
virtual unsigned int	getNumberOfHydrogens () Returns the number of hydrogens.
virtual unsigned int	getNumberOfMolecules () Returns the number of molecules.
virtual unsigned int	getNumberOfNitrogens () Returns the number of nitrogens.
virtual unsigned int	getNumberOfOtherAtoms () Returns the number of other atoms.
virtual unsigned int	getNumberOfOxygens () Returns the number of oxygens.
virtual unsigned int	getNumberOfResidues () Returns the number of residues.
virtual unsigned int	getNumberOfSegments () Returns the number of segments.
virtual unsigned int	getNumberOfStructuralGroups () Returns the number of structural groups.
virtual unsigned int	getNumberOfStructuralModels () Returns the number of structural models.
virtual unsigned int	getNumberOfSulfurs () Returns the number of sulfurs.
virtual unsigned int	getOpacity () const Returns the opacity.
unsigned int	getOpacitySingleStep () const Returns the opacity single step.
std::string	getOpacitySuffix () const Returns the opacity suffix.
SBDDataGraphNode *	getParent () const Returns the parent of the node.
SBDDataGraphNode *	getPreviousNode () const Returns the pointer to the previous node in the children of the node's parent.
SBDDataGraphNode *	getPreviousNode (SBDDataGraphNode::Type nodeType) const Returns the pointer to the previous node with type nodeType in the children of the node's parent.
SBDDataGraphNode *	getRoot () const Returns the root of the hierarchy the node belongs to.
bool	getSelected () const Returns whether the node is selected.
bool	getSelectionFlag () const Returns the selection flag.
virtual int	getSumOfFormalCharges () Returns the sum of formal charges.
virtual float	getSumOfPartialCharges () Returns the sum of partial charges.
SBDDataGraphNode *	getThisNode () const Returns the pointer to this node.
virtual unsigned int	getTransparency () const Returns the transparency.
unsigned int	getTransparencySingleStep () const Returns the transparency single step.
std::string	getTransparencySuffix () const Returns the transparency suffix.
virtual Type	getType () const Returns the type of the data graph node.
std::string	getTypeString (bool humanReadable=false) const Returns a string describing the type of the data graph node.
bool	getVisibilityFlag () const Returns the visibility flag.
bool	getVisible () const Returns whether the node is visible.
bool	hasMaterial () const Returns whether the node has a material (by itself, or inherited)
virtual bool	hasNode (SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Returns whether the node has nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies.
virtual bool	hasNode (const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Returns whether the node has nodes based on a selectionPredicate and avisitPredicate , with or without dependencies.
bool	hasOneOf (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer , or is the ancestor of one of them, or is a group that stores one of them.
bool	hasOpacityRange () const Returns whether the node has the opacity range.
bool	hasTransparencyRange () const Returns whether the node has the transparency range.
bool	isAtom () const Returns true when the node is an atom.
bool	isBallAndStick () const Returns true when the node is the default ball-and-stick visual model.
bool	isBond () const Returns true when the node is a bond.
bool	isCartoon () const Returns true when the node is the default cartoon visual model.
bool	isCreated () const Returns true if and only if the node is created.
bool	isDynamicalModel () const Returns true when the node is a dynamical model.
bool	isErased () const Returns true if and only if the node is erased.
bool	isGaussianSurface () const Returns true when the node is the default Gaussian surface visual model.
bool	isHighlighted () const Returns whether the node is highlighted.
bool	isIn (const SBDDataGraphNode * node) const Returns true if and only if this node isnode , or descends from it, or belongs to a group stored innode .
bool	isIn (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer , or descends from one of them, or belongs to a group stored in one of the nodes of thenodeIndexer .
bool	isIn (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns true if and only if this node is one of the nodes of thenodePointerIndexer , or descends from one of them, or belongs to a group stored in of the nodes of thenodePointerIndexer .
bool	isInteractionModel () const Returns true when the node is a interaction model.
bool	isLicorice () const Returns true when the node is the default licorice visual model.
bool	isLight () const Returns true when the node is a light.
virtual bool	isLocked () const Returns whether the node is locked.
bool	isMesh () const Returns true when the node is a mesh.
bool	isModel () const Returns true when the node is a model.
bool	isOneOf (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer .
bool	isOneOf (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns true if and only if this node is one of the nodes of thenodePointerIndexer .
bool	isPropertyModel () const Returns true when the node is a property model.
bool	isRibbon () const Returns true when the node is the default ribbon visual model.
bool	isSelected () const Returns whether the node is selected.
virtual bool	isSerializable () const Returns true when the class is serializable.
bool	isSimulator () const Returns true when the node is a simulator.
bool	isSolventAccessibleSurface () const Returns true when the node is the default solvent accessible surface visual model.
bool	isSolventExcludedSurface () const Returns true when the node is the default solvent excluded surface visual model.
bool	isStructuralModel () const Returns true when the node is a structural model.
bool	isStructuralNode () const Returns true when the node is a structural node.
bool	isTube () const Returns true when the node is the default tube visual model.
bool	isType (Type type) const Returns true when the type of the node corresponds totype .
bool	isVanDerWaals () const Returns true when the node is the default van der Waals visual model.
bool	isVisible () const Returns whether the node is visible.
bool	isVisualModel () const Returns true when the node is a visual model.
bool	ownsMaterial () const Returns whether the node owns a material.
virtual void	print (unsigned int offset=0) const Prints some debugging information.
virtual bool	removeChild (SBDDataGraphNode * node) Removes a child from the node.
bool	removeMaterial () Removes the material.
void	removeMaterialsFromDescendants () Removes materials from all nodes that descend from this node, but it does not remove the material from the node itself.
virtual void	serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) const Serializes the node.
void	setHighlightingFlag (bool flag) Sets the highlighting flag.
virtual void	setLockedFlag (bool flag) Sets the locked flag.
virtual void	setName (const std::string & name) Sets the name of the node.
virtual void	setOpacity (unsigned int opacity) Sets the opacity.
void	setSelectionFlag (bool flag) Sets the selection flag.
virtual void	setTransparency (unsigned int transparency) Sets the transparency.
void	setVisibilityFlag (bool flag) Sets the visibility flag.
virtual void	unserialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) Unserializes the node.

Public Functions inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget () Builds the reference target.
unsigned int	getMemoryFootprint () const Returns the memory footprint.
void	printReferencesToOwners () const Prints the references to the owners of this reference target.
virtual	~SBCReferenceTarget () Destructor.

Public Static Functions inherited from SBDDataGraphNode

See SBDDataGraphNode

Type	Name
bool	canAddMaterial (SBDDataGraphNode::Type nodeType) Returns whether can add a material to a node of type nodeType .
void	clone (const SBNodeIndexer & sourceNodeIndexer, SBNodeIndexer & destinationNodeIndexer) Clones the nodes in sourceNodeIndexer (treated as a whole) and places the clones indestinationNodeIndexer .
void	forEachNodeInSelection (SBNodeIndexer & nodeIndexer, void(*)(SBDDataGraphNode *node) action) Performs the action for each node innodeIndexer __
void	forEachNodeInSelection (SBNodeIndexer & nodeIndexer, SBCClass * object, void(SBCClass::*)(SBDDataGraphNode *node) action) Performs the objects 'saction for each node innodeIndexer __
SBDDataGraphNode *	getNode (unsigned int nodeIndex) Returns the unique node corresponding to the node index nodeIndex .
std::string	getTypeString (Type type, bool humanReadable=false) Returns a string describing the type of the data graph node.

Protected Attributes inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
SBCReferenceTargetData *	dataPointer A pointer to the private data.

Protected Functions

Type	Name
	SBDDocumentFolder (SBDDocumentFolderData * dataPointer) Builds a folder.

Protected Functions inherited from SBDDataGraphNode

See SBDDataGraphNode

Type	Name
	SBDDataGraphNode () Builds a data graph node.
	SBDDataGraphNode (SBDDataGraphNodeData * dataPointer) Builds a data graph node.
virtual	~SBDDataGraphNode () Destroys the node.

Protected Functions inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget (SBCReferenceTargetData * dataPointer) Protected constructor.
void	removeAllReferenceOwners () Stops all the reference owners from referencing this reference target.

Detailed Description

A document folder may contain structural models, dynamical models, interaction models, visual models, property models, simulators and controllers.

Short name: SBFolder

See also: SBDDocument , SBMStructuralModel , SBMDynamicalModel , SBMInteractionModel , SBMVisualModel , SBMPropertyModel , SBSSimulator , SBDController

Public Functions Documentation

function SBDDocumentFolder [1/3]

Constructs a folder.

SBDDocumentFolder::SBDDocumentFolder () 

Constructs a folder with default settings.

Creates a new folder with an automatically assigned name.

---

function SBDDocumentFolder [2/3]

Constructs a folder with name name .

SBDDocumentFolder::SBDDocumentFolder (
    const std::string & name
) 

Constructs a folder with the specified name.

Parameters:

• n The name of the folder.

---

function addChild

Adds a child to the folder.

virtual bool SBDDocumentFolder::addChild (
    SBNode * node,
    SBNode * nextNode=nullptr
) override

Adds a child node to the folder.

Parameters:

• node The node to add.
• nextNode The node after which node should be inserted, or nullptr to append at the end.

Returns:

true if the node was successfully added, otherwise false.

---

function canAddChild

Returns whether this node can add node as a child.

virtual bool SBDDocumentFolder::canAddChild (
    const SBNode * node,
    const SBNode * nextNode=nullptr
) override const

Determines whether the specified node can be added as a child of this folder.

Parameters:

• node The node to be added.
• nextNode The node after which node would be inserted, or nullptr to append at the end.

Returns:

true if the node can be added, otherwise false.

---

function canAddChildType

Returns whether this node can add a node with type nodeType as a child.

virtual bool SBDDocumentFolder::canAddChildType (
    SBNode::Type nodeType
) override const

Determines whether a child node of the given type can be added to this folder.

Parameters:

• nodeType The type of node to be added.

Returns:

true if a node of this type can be added, otherwise false.

Implements SBDDataGraphNode::canAddChildType

---

function canHaveDescendantType

Returns whether this node can have a node with type nodeType as a descendant.

virtual bool SBDDocumentFolder::canHaveDescendantType (
    SBNode::Type nodeType
) override const

Determines whether the folder can have a descendant of the specified type.

Parameters:

• nodeType The type of descendant node.

Returns:

true if a descendant of this type is allowed, otherwise false.

Implements SBDDataGraphNode::canHaveDescendantType

---

function clone

Returns a copy of the node and its descendants.

virtual SBDDocumentFolder * SBDDocumentFolder::clone () override

Creates a copy of the folder and all its descendants.

Returns:

Pointer to the newly cloned folder.

Implements SBDDataGraphNode::clone

---

function connectDocumentSignalToSlot

Connects the document signal to a slot.

void SBDDocumentFolder::connectDocumentSignalToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBDocumentEvent *) functionPointer,
    SBCReferenceTarget * nextReferenceTarget=0,
    void(SBCReferenceTarget::*)( SBDocumentEvent *) nextFunctionPointer=0
) 

Connects the document signal to a slot on the specified reference target.

Parameters:

• referenceTarget Target object whose slot will be connected.
• functionPointer Pointer to the member function to be used as the slot.
• nextReferenceTarget Optional target for the next slot in the connection chain.
• nextFunctionPointer Optional member function pointer for the next slot.

---

function disconnectDocumentSignalFromSlot

Disconnects the document signal from a slot.

void SBDDocumentFolder::disconnectDocumentSignalFromSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBDocumentEvent *) functionPointer
) 

Disconnects the document signal from a slot on the specified reference target.

Parameters:

• referenceTarget Target object whose slot will be disconnected.
• functionPointer Pointer to the member function representing the slot.

---

function documentSignalIsConnectedToSlot

Returns true if and only if the document signal is connected to the slot.

bool SBDDocumentFolder::documentSignalIsConnectedToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBDocumentEvent *) functionPointer
) const

Checks whether the document signal is connected to a specific slot.

Parameters:

• referenceTarget Target object.
• functionPointer Pointer to the member function.

Returns:

true if the slot is connected; otherwise false.

---

function forEachNodeDepthFirst [1/2]

Performs the action on each node of this folder (the folder itself and its children), depth-first.

virtual void SBDDocumentFolder::forEachNodeDepthFirst (
    void(*)( SBNode *node) action
) override

Executes the given action on each node in depth‑first order.

Parameters:

• action Function pointer to be called for each node.

---

function forEachNodeDepthFirst [2/2]

Performs the object 'saction on each node of this folder (the folder itself and its children), depth-first.

virtual void SBDDocumentFolder::forEachNodeDepthFirst (
    SBCClass * object,
    void(SBCClass::*)( SBNode *node) action
) override

Executes the given member function on each node in depth‑first order.

Parameters:

• object Object whose member function will be invoked.
• action Member function pointer to be called for each node.

---

function getAnimationList

Returns the list of animations.

SBPointerList< SBAnimation > const * SBDDocumentFolder::getAnimationList () const

Returns the list of animations in the folder.

Returns:

Pointer to a constant list of animation pointers.

---

function getAssetList

Returns the list of assets.

SBPointerList< SBAsset > const * SBDDocumentFolder::getAssetList () const

Returns the list of assets in the folder.

Returns:

Pointer to a constant list of asset pointers.

---

function getCameraList

Returns the list of cameras.

SBPointerList< SBCamera > const * SBDDocumentFolder::getCameraList () const

Returns the list of cameras in the folder.

Returns:

Pointer to a constant list of camera pointers.

---

function getChildren

Returns the children of the folder.

SBPointerList< SBNode > const * SBDDocumentFolder::getChildren () const

Returns the list of child nodes contained in the folder.

Returns:

Pointer to a constant list of child nodes, or nullptr if no data pointer is available.

---

function getConformationList

Returns the list of conformations.

SBPointerList< SBConformation > const * SBDDocumentFolder::getConformationList () const

Returns the list of conformations in the folder.

Returns:

Pointer to a constant list of conformation pointers.

---

function getControllerList

Returns the list of controllers.

SBPointerList< SBDController > const * SBDDocumentFolder::getControllerList () const

Returns the list of controllers in the folder.

Returns:

Pointer to a constant list of controller pointers.

---

function getDynamicalModelList

Returns the list of dynamical models.

SBPointerList< SBMDynamicalModel > const * SBDDocumentFolder::getDynamicalModelList () const

Returns the list of dynamical models in the folder.

Returns:

Pointer to a constant list of dynamical model pointers.

---

function getFileList

Returns the list of files.

SBPointerList< SBFile > const * SBDDocumentFolder::getFileList () const

Returns the list of files in the folder.

Returns:

Pointer to a constant list of file pointers.

---

function getFolderList

Returns the list of folders.

SBPointerList< SBDDocumentFolder > const * SBDDocumentFolder::getFolderList () const

Returns the list of subfolders in the folder.

Returns:

Pointer to a constant list of folder pointers.

---

function getInteractionModelList

Returns the list of interaction models.

SBPointerList< SBMInteractionModel > const * SBDDocumentFolder::getInteractionModelList () const

Returns the list of interaction models in the folder.

Returns:

Pointer to a constant list of interaction model pointers.

---

function getLabelList

Returns the list of labels.

SBPointerList< SBLabel > const * SBDDocumentFolder::getLabelList () const

Returns the list of labels in the folder.

Returns:

Pointer to a constant list of label pointers.

---

function getLightList

Returns the list of lights.

SBPointerList< SBLight > const * SBDDocumentFolder::getLightList () const

Returns the list of lights in the folder.

Returns:

Pointer to a constant list of light pointers.

---

function getModelList

Returns the list of models.

SBPointerList< SBMModel > const * SBDDocumentFolder::getModelList () const

Returns the list of all models in the folder.

Returns:

Pointer to a constant list of model pointers.

---

function getMolecularWeight

Returns the molecular weight.

virtual SBQuantity::mass SBDDocumentFolder::getMolecularWeight () override

Returns the molecular weight of the contents of this folder.

Returns:

The molecular weight.

Implements SBDDataGraphNode::getMolecularWeight

---

function getNextFolder

Returns the next folder.

SBDDocumentFolder * SBDDocumentFolder::getNextFolder () const

Retrieves the next folder in the document sequence.

Returns:

Pointer to the next folder, or nullptr if this is the last folder.

---

function getNodeGroupList

Returns the list of node groups.

SBPointerList< SBNodeGroup > const * SBDDocumentFolder::getNodeGroupList () const

Returns the list of node groups in the folder.

Returns:

Pointer to a constant list of node group pointers.

---

function getNodes [1/2]

Collects nodes into nodeIndexer , based on anodeType , a selection status and avisitPredicate , with or without dependencies.

virtual void SBDDocumentFolder::getNodes (
    SBNodeIndexer & nodeIndexer,
    SBNode::Type nodeType,
    bool selectedNodesOnly=false,
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Collects nodes of the specified type into the given indexer.

Parameters:

• nodeIndexer Indexer that receives the collected nodes.
• nodeType Type of nodes to collect.
• selectedNodesOnly If true, only include selected nodes.
• visitPredicate Predicate that determines whether a node should be visited.
• includeDependencies Whether to include dependent nodes.

Implements SBDDataGraphNode::getNodes

---

function getNodes [2/2]

Collects nodes into nodeIndexer , based on aselectionPredicate and avisitPredicate , with or without dependencies.

virtual void SBDDocumentFolder::getNodes (
    SBNodeIndexer & nodeIndexer,
    const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(),
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Collects nodes that satisfy the selection predicate into the given indexer.

Parameters:

• nodeIndexer Indexer that receives the collected nodes.
• selectionPredicate Predicate that determines whether a node should be selected.
• visitPredicate Predicate that determines whether a node should be visited.
• includeDependencies Whether to include dependent nodes.

Implements SBDDataGraphNode::getNodes

---

function getNoteList

Returns the list of notes.

SBPointerList< SBNote > const * SBDDocumentFolder::getNoteList () const

Returns the list of notes in the folder.

Returns:

Pointer to a constant list of note pointers.

---

function getNumberOfAtoms

Returns the number of atoms.

virtual unsigned int SBDDocumentFolder::getNumberOfAtoms () override

Returns the number of atoms contained in this folder.

Returns:

The number of atoms.

Implements SBDDataGraphNode::getNumberOfAtoms

---

function getNumberOfCarbons

Returns the number of carbons.

virtual unsigned int SBDDocumentFolder::getNumberOfCarbons () override

Returns the number of carbon atoms contained in this folder.

Returns:

The number of carbon atoms.

Implements SBDDataGraphNode::getNumberOfCarbons

---

function getNumberOfChains

Returns the number of chains.

virtual unsigned int SBDDocumentFolder::getNumberOfChains () override

Returns the number of chains in the folder.

Returns:

The number of chains.

Implements SBDDataGraphNode::getNumberOfChains

---

function getNumberOfCoarseGrainedAtoms

Returns the number of coarse-grained atoms.

virtual unsigned int SBDDocumentFolder::getNumberOfCoarseGrainedAtoms () override

Returns the number of coarse‑grained atoms contained in this folder.

Returns:

The number of coarse‑grained atoms.

Implements SBDDataGraphNode::getNumberOfCoarseGrainedAtoms

---

function getNumberOfHydrogens

Returns the number of hydrogens.

virtual unsigned int SBDDocumentFolder::getNumberOfHydrogens () override

Returns the number of hydrogen atoms contained in this folder.

Returns:

The number of hydrogen atoms.

Implements SBDDataGraphNode::getNumberOfHydrogens

---

function getNumberOfMolecules

Returns the number of molecules.

virtual unsigned int SBDDocumentFolder::getNumberOfMolecules () override

Returns the number of molecules contained in this folder.

Returns:

The number of molecules.

Implements SBDDataGraphNode::getNumberOfMolecules

---

function getNumberOfNitrogens

Returns the number of nitrogens.

virtual unsigned int SBDDocumentFolder::getNumberOfNitrogens () override

Returns the number of nitrogen atoms contained in this folder.

Returns:

The number of nitrogen atoms.

Implements SBDDataGraphNode::getNumberOfNitrogens

---

function getNumberOfOtherAtoms

Returns the number of other atoms.

virtual unsigned int SBDDocumentFolder::getNumberOfOtherAtoms () override

Returns the number of other atoms contained in this folder.

Returns:

The number of other atoms.

Implements SBDDataGraphNode::getNumberOfOtherAtoms

---

function getNumberOfOxygens

Returns the number of oxygens.

virtual unsigned int SBDDocumentFolder::getNumberOfOxygens () override

Returns the number of oxygen atoms contained in this folder.

Returns:

The number of oxygen atoms.

Implements SBDDataGraphNode::getNumberOfOxygens

---

function getNumberOfResidues

Returns the number of residues.

virtual unsigned int SBDDocumentFolder::getNumberOfResidues () override

Returns the number of residues contained in this folder.

Returns:

The number of residues.

Implements SBDDataGraphNode::getNumberOfResidues

---

function getNumberOfSegments

Returns the number of segments.

virtual unsigned int SBDDocumentFolder::getNumberOfSegments () override

Returns the number of segments contained in this folder.

Returns:

The number of segments.

Implements SBDDataGraphNode::getNumberOfSegments

---

function getNumberOfStructuralGroups

Returns the number of structural groups.

virtual unsigned int SBDDocumentFolder::getNumberOfStructuralGroups () override

Returns the number of structural groups contained in this folder.

Returns:

The number of structural groups.

Implements SBDDataGraphNode::getNumberOfStructuralGroups

---

function getNumberOfStructuralModels

Returns the number of structural models.

virtual unsigned int SBDDocumentFolder::getNumberOfStructuralModels () override

Returns the number of structural models contained in this folder.

Returns:

The number of structural models.

Implements SBDDataGraphNode::getNumberOfStructuralModels

---

function getNumberOfSulfurs

Returns the number of sulfurs.

virtual unsigned int SBDDocumentFolder::getNumberOfSulfurs () override

Returns the number of sulfur atoms contained in this folder.

Returns:

The number of sulfur atoms.

Implements SBDDataGraphNode::getNumberOfSulfurs

---

function getOpacity

Returns the opacity.

virtual unsigned int SBDDocumentFolder::getOpacity () override const

Returns the opacity of the folder as a percentage (0-100).

Returns:

The opacity value.

Implements SBDDataGraphNode::getOpacity

---

function getPathList

Returns the list of paths.

SBPointerList< SBPath > const * SBDDocumentFolder::getPathList () const

Returns the list of paths in the folder.

Returns:

Pointer to a constant list of path pointers.

---

function getPresentationList

Returns the list of presentations.

SBPointerList< SBPresentation > const * SBDDocumentFolder::getPresentationList () const

Returns the list of presentations in the folder.

Returns:

Pointer to a constant list of presentation pointers.

---

function getPreviousFolder

Returns the previous folder.

SBDDocumentFolder * SBDDocumentFolder::getPreviousFolder () const

Retrieves the previous folder in the document sequence.

Returns:

Pointer to the previous folder, or nullptr if this is the first folder.

---

function getPropertyModelList

Returns the list of property models.

SBPointerList< SBMPropertyModel > const * SBDDocumentFolder::getPropertyModelList () const

Returns the list of property models in the folder.

Returns:

Pointer to a constant list of property model pointers.

---

function getRenderPresetList

Returns the list of render presets.

SBPointerList< SBRenderPreset > const * SBDDocumentFolder::getRenderPresetList () const

Returns the list of render presets in the folder.

Returns:

Pointer to a constant list of render preset pointers.

---

function getSimulatorList

Returns the list of Simulators.

SBPointerList< SBSSimulator > const * SBDDocumentFolder::getSimulatorList () const

Returns the list of simulators in the folder.

Returns:

Pointer to a constant list of simulator pointers.

---

function getStructuralModelList

Returns the list of structural models.

SBPointerList< SBMStructuralModel > const * SBDDocumentFolder::getStructuralModelList () const

Returns the list of structural models in the folder.

Returns:

Pointer to a constant list of structural model pointers.

---

function getSumOfFormalCharges

Returns the sum of formal charges.

virtual int SBDDocumentFolder::getSumOfFormalCharges () override

Returns the sum of formal charges of all atoms in this folder.

Returns:

The sum of formal charges.

Implements SBDDataGraphNode::getSumOfFormalCharges

---

function getSumOfPartialCharges

Returns the sum of partial charges.

virtual float SBDDocumentFolder::getSumOfPartialCharges () override

Returns the sum of partial charges of all atoms in this folder.

Returns:

The sum of partial charges.

Implements SBDDataGraphNode::getSumOfPartialCharges

---

function getTransparency

Returns the transparency.

virtual unsigned int SBDDocumentFolder::getTransparency () override const

Returns the transparency of the folder as a percentage (0-100).

Returns:

The transparency value.

Implements SBDDataGraphNode::getTransparency

---

function getType

Returns the data graph node type.

virtual SBDDataGraphNode::Type SBDDocumentFolder::getType () override const

Implements SBDDataGraphNode::getType

---

function getVisualModelList

Returns the list of visual models.

SBPointerList< SBMVisualModel > const * SBDDocumentFolder::getVisualModelList () const

Returns the list of visual models in the folder.

Returns:

Pointer to a constant list of visual model pointers.

---

function hasNode [1/2]

Checks for nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies.

virtual bool SBDDocumentFolder::hasNode (
    SBNode::Type nodeType,
    bool selectedNodesOnly=false,
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Checks whether a node of the given type exists in the folder.

Parameters:

• nodeType Type of node to search for.
• selectedNodesOnly If true, only consider selected nodes.
• visitPredicate Predicate that determines whether a node should be visited.
• includeDependencies Whether to include dependent nodes.

Returns:

true if a matching node exists; otherwise false.

Implements SBDDataGraphNode::hasNode

---

function hasNode [2/2]

Checks for nodes based on a selectionPredicate and avisitPredicate , with or without dependencies.

virtual bool SBDDocumentFolder::hasNode (
    const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(),
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Checks whether any node satisfying the selection predicate exists in the folder.

Parameters:

• selectionPredicate Predicate that determines whether a node should be selected.
• visitPredicate Predicate that determines whether a node should be visited.
• includeDependencies Whether to include dependent nodes.

Returns:

true if a matching node exists; otherwise false.

Implements SBDDataGraphNode::hasNode

---

function initialize

Initializes the folder.

virtual bool SBDDocumentFolder::initialize () 

Performs any necessary initialization for the folder.

Returns:

true if initialization succeeded.

---

function isSerializable

Returns true __

virtual bool SBDDocumentFolder::isSerializable () override const

Indicates whether the folder can be serialized.

Returns:

true because folders are always serializable.

Implements SBDDataGraphNode::isSerializable

---

function print

Prints the folder.

virtual void SBDDocumentFolder::print (
    unsigned int offset=0
) override const

Prints a textual representation of the folder and its children.

Parameters:

• offset Number of indentation levels to apply before each line.

Implements SBDDataGraphNode::print

---

function removeChild

Removes a child from the folder.

virtual bool SBDDocumentFolder::removeChild (
    SBNode * node
) override

Removes a child node from the folder.

Parameters:

• node The node to remove.

Returns:

true if the node was successfully removed, otherwise false.

---

function serialize

Serializes the folder.

virtual void SBDDocumentFolder::serialize (
    SBCSerializer * serializer,
    const SBNodeIndexer & nodeIndexer,
    const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
    const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) override const

Serializes the folder to the given serializer.

Parameters:

• serializer The serializer used to write the folder data.
• nodeIndexer Indexer that maps nodes to indices for serialization.
• sdkVersionNumber The version of the SDK used for serialization.
• classVersionNumber The version of the class for serialization.

Implements SBDDataGraphNode::serialize

---

function setOpacity

Sets the opacity.

virtual void SBDDocumentFolder::setOpacity (
    unsigned int opacity
) override

Sets the opacity of the folder.

Parameters:

• opacity The new opacity value as a percentage (0-100).

Implements SBDDataGraphNode::setOpacity

---

function setTransparency

Sets the transparency.

virtual void SBDDocumentFolder::setTransparency (
    unsigned int transparency
) override

Sets the folder's transparency, using an undo command if applicable.

Parameters:

• transparency The new transparency value as a percentage (0-100).

Implements SBDDataGraphNode::setTransparency

---

function unserialize

Unserializes the folder.

virtual void SBDDocumentFolder::unserialize (
    SBCSerializer * serializer,
    const SBNodeIndexer & nodeIndexer,
    const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
    const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) override

Unserializes the folder from the given serializer.

Parameters:

• serializer The serializer used to read the folder data.
• nodeIndexer Indexer that maps indices to nodes for deserialization.
• sdkVersionNumber The version of the SDK used for deserialization.
• classVersionNumber The version of the class for deserialization.

Implements SBDDataGraphNode::unserialize

---

function ~SBDDocumentFolder

Destructs the folder.

virtual SBDDocumentFolder::~SBDDocumentFolder () 

Destroys the folder and releases associated resources.

---

Protected Functions Documentation

function SBDDocumentFolder [3/3]

Builds a folder.

SBDDocumentFolder::SBDDocumentFolder (
    SBDDocumentFolderData * dataPointer
) 

Constructs a folder using the provided data pointer.

Parameters:

• dataPointer Pointer to the internal data structure.

---