Class SBDController

ClassList > SBDController

This class is the base class of controllers. More...

• #include <SBDController.hpp>

Inherits the following classes: SBDDataGraphNode

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
	SBDController () Constructs a controller.
	SBDController (const SBValueMap & parameterMap) Constructs a controller.
virtual bool	addChild (SBNode * node, SBNode * nextNode=nullptr) override Adds a child to the controller.
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 void	changed () Emits the ControllerStateChanged event.
virtual SBDController *	clone () override Returns a copy of the node and its descendants.
void	connectControllerSignalToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBControllerEvent *) functionPointer, SBCReferenceTarget * nextReferenceTarget=0, void(SBCReferenceTarget::*)(SBControllerEvent *) nextFunctionPointer=0) Connects the controller signal to a slot.
bool	controllerSignalIsConnectedToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBControllerEvent *) functionPointer) const Returns true if and only if the controller signal is connected to the slot.
void	disconnectControllerSignalFromSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBControllerEvent *) functionPointer) Disconnects the controller signal from a slot.
virtual void	display (SBNode::RenderingPass renderingPass) override Displays the controller.
virtual void	forEachNodeDepthFirst (void(*)(SBNode *node) action) override Performs the action on each node of this controller (the controller 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 controller (the controller itself and its children), depth-first.
SBPointerList< SBDControllerNode > const *	getChildren () const Returns the list of children of the controller.
SBDController *	getNextController () const Returns the next controller in the document.
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.
SBDController *	getPreviousController () const Returns the previous controller in the document.
virtual SBDDataGraphNode::Type	getType () override const Returns the type of the data graph node.
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	isSerializable () override const Returns true when the class is serializable.
virtual void	pressed (SBDControllerNode * auxiliaryNode=nullptr) Emits the ControllerPressed event.
virtual void	print (unsigned int offset=0) override const Prints debugging information.
virtual void	released (SBDControllerNode * auxiliaryNode=nullptr) Emits the ControllerReleased event.
virtual bool	removeChild (SBNode * node) override Removes a child from the controller.
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 node.
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 node.
virtual	~SBDController () Destructs the controller.

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
	SBDController (SBDControllerData * dataPointer) Builds a controller.

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

Short name: SBController

Public Functions Documentation

function SBDController [2/3]

Constructs a controller.

SBDController::SBDController () 

Initializes a new SBDController instance with a default data pointer.

---

function SBDController [3/3]

Constructs a controller.

SBDController::SBDController (
    const SBValueMap & parameterMap
) 

Constructs a controller with given parameters.

Initializes a new SBDController using the provided parameter map.

Parameters:

• parameterMap Map of parameters used to configure the controller.

---

function addChild

Adds a child to the controller.

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

Adds a child node to the controller.

Inserts the specified node as a child of this controller, optionally placing it before a given sibling node.

Parameters:

• node Pointer to the node to add as a child.
• nextNode Optional pointer to the sibling node after which the new node will be inserted; may be nullptr.

Returns:

true if the child was successfully added; otherwise false.

---

function canAddChild

Returns whether this node can add node as a child.

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

Determines if a node can be added as a child.

Checks whether the specified node can be added as a child of this controller, optionally considering a sibling node.

Parameters:

• node Pointer to the node to be added.
• nextNode Optional pointer to the node after which the new node will be inserted; may be nullptr.

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 SBDController::canAddChildType (
    SBNode::Type nodeType
) override const

Checks if a node type can be added as a child.

Determines whether nodes of the specified type are allowed as children of this controller.

Parameters:

• nodeType The type of node to check.

Returns:

true if nodes of this type can be added as children; otherwise false.

Implements SBDDataGraphNode::canAddChildType

---

function canHaveDescendantType

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

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

Checks if a node type can appear as a descendant.

Determines whether nodes of the given type are permitted anywhere in the subtree of this controller.

Parameters:

• nodeType The type of node to check.

Returns:

true if nodes of this type can be descendants; otherwise false.

Implements SBDDataGraphNode::canHaveDescendantType

---

function changed

Emits the ControllerStateChanged event.

virtual void SBDController::changed () 

Emits a state changed event for the controller.

Generates a ControllerStateChanged event to indicate the controller's state has changed.

---

function clone

Returns a copy of the node and its descendants.

virtual SBDController * SBDController::clone () override

Creates a copy of the controller.

Returns a new controller instance that is a copy of this node and its descendants.

Returns:

Pointer to the cloned controller.

Implements SBDDataGraphNode::clone

---

function connectControllerSignalToSlot

Connects the controller signal to a slot.

void SBDController::connectControllerSignalToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBControllerEvent *) functionPointer,
    SBCReferenceTarget * nextReferenceTarget=0,
    void(SBCReferenceTarget::*)( SBControllerEvent *) nextFunctionPointer=0
) 

Connects a controller signal to a slot.

Establishes a connection between the controller's signal and a slot on the specified reference target.

Parameters:

• referenceTarget The target object that will receive the signal.
• functionPointer Pointer to the member function of the target that will handle the signal.
• nextReferenceTarget Optional target for a subsequent connection; may be nullptr.
• nextFunctionPointer Optional member function pointer for the subsequent connection; may be nullptr.

---

function controllerSignalIsConnectedToSlot

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

bool SBDController::controllerSignalIsConnectedToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBControllerEvent *) functionPointer
) const

Checks if a controller signal is connected to a slot.

Determines whether the specified target and function are currently connected to the controller's signal.

Parameters:

• referenceTarget The target object to check.
• functionPointer Pointer to the member function to check.

Returns:

true if the signal is connected to the slot; otherwise false.

---

function disconnectControllerSignalFromSlot

Disconnects the controller signal from a slot.

void SBDController::disconnectControllerSignalFromSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBControllerEvent *) functionPointer
) 

Disconnects a controller signal from a slot.

Removes the connection between the controller's signal and the specified target's slot.

Parameters:

• referenceTarget The target object from which to disconnect.
• functionPointer Pointer to the member function to disconnect.

---

function display

Displays the controller.

virtual void SBDController::display (
    SBNode::RenderingPass renderingPass
) override

Renders the controller and its child nodes for the specified rendering pass.

Parameters:

• renderingPass The rendering pass indicating the context in which to display.

Implements SBDDataGraphNode::display

---

function forEachNodeDepthFirst [1/2]

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

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

Performs an action on each node in depth-first order.

Calls the provided function for this controller and all its descendant nodes, traversing depth-first.

Parameters:

• action Function pointer to be invoked for each node.

---

function forEachNodeDepthFirst [2/2]

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

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

Performs an action on each node in depth-first order using a member function.

Calls the specified member function on the given object for this controller and all its descendant nodes, traversing depth-first.

Parameters:

• object Pointer to the object whose member function will be called.
• action Pointer to the member function to invoke for each node.

---

function getChildren

Returns the list of children of the controller.

SBPointerList< SBDControllerNode > const * SBDController::getChildren () const

Retrieves the list of child nodes.

Returns a pointer to the list containing this controller's children, or nullptr if no children exist.

Returns:

Pointer to the child list, or nullptr if the controller has no children.

---

function getNextController

Returns the next controller in the document.

SBDController * SBDController::getNextController () const

Retrieves the next controller in the document.

Searches forward from this controller and returns the next controller node if one exists.

Returns:

Pointer to the next controller, or nullptr if none is found.

---

function getNodes [1/2]

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

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

Collects nodes of a specific type.

Adds nodes matching the given type to the node indexer, optionally filtering by selection status and a visit predicate.

Parameters:

• nodeIndexer Indexer that will receive the collected nodes.
• nodeType The type of nodes to collect.
• selectedNodesOnly If true, only selected nodes are collected.
• visitPredicate Predicate to determine whether to traverse a node.
• includeDependencies If true, includes dependent nodes in the collection.

Implements SBDDataGraphNode::getNodes

---

function getNodes [2/2]

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

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

Collects nodes based on a selection predicate.

Adds nodes that satisfy the selection predicate to the node indexer, optionally filtered by a visit predicate and including dependencies.

Parameters:

• nodeIndexer Indexer that will receive the collected nodes.
• selectionPredicate Predicate that selects nodes to include.
• visitPredicate Predicate that determines whether to traverse a node.
• includeDependencies If true, includes dependent nodes in the collection.

Implements SBDDataGraphNode::getNodes

---

function getPreviousController

Returns the previous controller in the document.

SBDController * SBDController::getPreviousController () const

Retrieves the previous controller in the document.

Searches backward from this controller and returns the previous controller node if one exists.

Returns:

Pointer to the previous controller, or nullptr if none is found.

---

function getType

Returns the type of the data graph node.

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

Retrieves the type of the data graph node.

Returns the enum value representing a controller node.

Returns:

The node type identifier for a controller.

Implements SBDDataGraphNode::getType

---

function hasNode [1/2]

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

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

Checks for the presence of nodes of a specific type.

Determines whether the controller or its descendants contain a node of the given type, optionally filtering by selection status and a visit predicate.

Parameters:

• nodeType The type of node to check for.
• selectedNodesOnly If true, only selected nodes are considered.
• visitPredicate Predicate to determine whether to traverse a node.
• includeDependencies If true, includes dependent nodes in the check.

Returns:

true if a matching node is found; otherwise false.

Implements SBDDataGraphNode::hasNode

---

function hasNode [2/2]

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

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

Checks for the presence of nodes matching a predicate.

Determines whether the controller or its descendants contain a node that satisfies the selection predicate, optionally filtered by a visit predicate and including dependencies.

Parameters:

• selectionPredicate Predicate that selects nodes to check.
• visitPredicate Predicate that determines whether to traverse a node.
• includeDependencies If true, includes dependent nodes in the check.

Returns:

true if a matching node is found; otherwise false.

Implements SBDDataGraphNode::hasNode

---

function isSerializable

Returns true when the class is serializable.

virtual bool SBDController::isSerializable () override const

Indicates whether the controller is serializable.

Returns true if the controller supports serialization; otherwise false.

Returns:

false indicating the controller is not serializable.

Implements SBDDataGraphNode::isSerializable

---

function pressed

Emits the ControllerPressed event.

virtual void SBDController::pressed (
    SBDControllerNode * auxiliaryNode=nullptr
) 

Emits a pressed event for the controller.

Generates a ControllerPressed event, optionally including an auxiliary node.

Parameters:

• auxiliaryNode Optional auxiliary node associated with the press event; may be nullptr.

---

function print

Prints debugging information.

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

Prints debugging information for the controller.

Outputs the controller's name and its children's information with indentation based on the provided offset.

Parameters:

• offset Number of indentation levels to apply before printing.

Implements SBDDataGraphNode::print

---

function released

Emits the ControllerReleased event.

virtual void SBDController::released (
    SBDControllerNode * auxiliaryNode=nullptr
) 

Emits a released event for the controller.

Generates a ControllerReleased event, optionally including an auxiliary node.

Parameters:

• auxiliaryNode Optional auxiliary node associated with the release event; may be nullptr.

---

function removeChild

Removes a child from the controller.

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

Removes a child node from the controller.

Detaches the specified child node from this controller.

Parameters:

• node Pointer to the child node to remove.

Returns:

true if the child was successfully removed; otherwise false.

---

function serialize

Serializes the node.

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

Serializes the controller.

Writes the controller's data to the given serializer, including its name and children.

Parameters:

• serializer Serializer used to write the data.
• nodeIndexer Indexer that maps nodes to indices.
• sdkVersionNumber SDK version number (default is SB_SDK_VERSION_NUMBER).
• classVersionNumber Class version number (default is SBVersionNumber(1, 0, 0)).

Implements SBDDataGraphNode::serialize

---

function unserialize

Unserializes the node.

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

Unserializes the controller.

Reads the controller's data from the given serializer and reconstructs its children.

Parameters:

• serializer Serializer used to read the data.
• nodeIndexer Indexer that maps indices to nodes.
• sdkVersionNumber SDK version number (default is SB_SDK_VERSION_NUMBER).
• classVersionNumber Class version number (default is SBVersionNumber(1, 0, 0)).

Implements SBDDataGraphNode::unserialize

---

function ~SBDController

Destructs the controller.

virtual SBDController::~SBDController () 

Cleans up resources associated with the SBDController.

---

Protected Functions Documentation

function SBDController [1/3]

Builds a controller.

SBDController::SBDController (
    SBDControllerData * dataPointer
) 

Constructs a controller from existing data.

Creates an SBDController that wraps the supplied data pointer.

Parameters:

• dataPointer Pointer to existing controller data.

---