Class SBDDocumentPresentation

ClassList > SBDDocumentPresentation

This class describes a presentation. More...

• #include <SBDDocumentPresentation.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
	SBDDocumentPresentation () Constructs a presentation.
	SBDDocumentPresentation (const std::string & name) Constructs a presentation with name name .
virtual bool	addChild (SBNode * node, SBNode * nextNode=nullptr) override Adds a child to the presentation.
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 SBDDocumentPresentation *	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 presentation (the presentation 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 presentation (the presentation itself and its children), depth-first.
int	getBeginFrame () const Returns the begin frame.
SBPointerList< SBNode > const *	getChildren () const Returns the children of the presentation.
int	getCurrentFrame () const Returns the current frame.
int	getEndFrame () const Returns the end frame.
SBDDocumentPresentation *	getNextPresentation () const Returns the next presentation.
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.
SBDDocumentPresentation *	getPreviousPresentation () const Returns the previous presentation.
virtual SBDDataGraphNode::Type	getType () override const Returns the data graph node type.
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 presentation.
virtual bool	isSerializable () override const Returns true __
virtual void	print (unsigned int offset=0) override const Prints the presentation.
virtual bool	removeChild (SBNode * node) override Removes a child from the presentation.
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 presentation.
void	setBeginFrame (int frame) Sets the begin frame.
void	setCurrentFrame (int frame) Sets the current frame.
void	setEndFrame (int frame) Sets the end frame.
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 presentation.
virtual	~SBDDocumentPresentation () Destructs the presentation.

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
	SBDDocumentPresentation (SBDDocumentPresentationData * dataPointer) Builds a presentation.

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 presentation may contain animations.

Short name: SBPresentation

See also: SBDDocumentAnimation

Public Functions Documentation

function SBDDocumentPresentation [1/3]

Constructs a presentation.

SBDDocumentPresentation::SBDDocumentPresentation () 

Constructs a new presentation.

Initializes a presentation with default settings.

---

function SBDDocumentPresentation [2/3]

Constructs a presentation with name name .

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

Constructs a presentation with the given name.

Parameters:

• n The name of the presentation.

---

function addChild

Adds a child to the presentation.

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

Adds a child node to the presentation.

Parameters:

• node The node to add as a child.
• nextNode The node before which the new child should be inserted (optional).

Returns:

true if the child was successfully added; otherwise false.

---

function canAddChild

Returns whether this node can add node as a child.

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

Determines whether a node can be added as a child of this presentation.

Parameters:

• node The node to be added.
• nextNode The node before which the new node should be inserted (optional).

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

Determines whether a node of a specific type can be added as a child.

Parameters:

• nodeType The type of node to be added.

Returns:

true if nodes of the given 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 SBDDocumentPresentation::canHaveDescendantType (
    SBNode::Type nodeType
) override const

Determines whether a descendant of a specific type can exist under this presentation.

Parameters:

• nodeType The type of descendant node to check for.

Returns:

true if a descendant of the given type is allowed; otherwise false.

Implements SBDDataGraphNode::canHaveDescendantType

---

function clone

Returns a copy of the node and its descendants.

virtual SBDDocumentPresentation * SBDDocumentPresentation::clone () override

Creates a copy of this presentation and its descendants.

Returns:

A pointer to the cloned presentation.

Implements SBDDataGraphNode::clone

---

function connectDocumentSignalToSlot

Connects the document signal to a slot.

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

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

Parameters:

• referenceTarget The target object whose slot will be connected.
• functionPointer Pointer to the member function to be called when the signal is emitted.
• nextReferenceTarget The next target in the slot chain (optional).
• nextFunctionPointer Pointer to the next member function in the slot chain (optional).

Supports undo by recording the connection if the Core is holding.

---

function disconnectDocumentSignalFromSlot

Disconnects the document signal from a slot.

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

Disconnects a document signal from a specific slot.

Parameters:

• referenceTarget The target object whose slot will be disconnected.
• functionPointer Pointer to the member function to disconnect.

Supports undo by recording the disconnection if the Core is holding.

---

function documentSignalIsConnectedToSlot

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

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

Checks if a document signal is connected to a specific slot.

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 forEachNodeDepthFirst [1/2]

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

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

Performs the given action on each node in the presentation depth-first.

Parameters:

• action Function to apply to each node.

---

function forEachNodeDepthFirst [2/2]

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

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

Performs the given member function on each node in the presentation depth-first.

Parameters:

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

---

function getBeginFrame

Returns the begin frame.

int SBDDocumentPresentation::getBeginFrame () const

Retrieves the beginning frame of the presentation.

Returns:

The begin frame value.

---

function getChildren

Returns the children of the presentation.

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

Retrieves the list of child nodes of the presentation.

Returns:

A pointer to the list of child nodes, or nullptr if unavailable.

---

function getCurrentFrame

Returns the current frame.

int SBDDocumentPresentation::getCurrentFrame () const

Retrieves the current frame of the presentation.

Returns:

The current frame value.

---

function getEndFrame

Returns the end frame.

int SBDDocumentPresentation::getEndFrame () const

Retrieves the ending frame of the presentation.

Returns:

The end frame value.

---

function getNextPresentation

Returns the next presentation.

SBDDocumentPresentation * SBDDocumentPresentation::getNextPresentation () const

Retrieves the next sibling presentation.

Returns:

Pointer to the next presentation, or nullptr if none exists.

---

function getNodes [1/2]

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

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

Collects nodes of a given type into a node indexer.

Parameters:

• nodeIndexer The indexer to collect matching nodes into.
• nodeType The type of nodes to collect.
• selectedNodesOnly If true, only selected nodes are collected.
• visitPredicate Predicate to determine if a node should be visited.
• 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 SBDDocumentPresentation::getNodes (
    SBNodeIndexer & nodeIndexer,
    const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(),
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Collects nodes into a node indexer based on a selection predicate.

Parameters:

• nodeIndexer The indexer to collect matching nodes into.
• selectionPredicate Predicate to select nodes.
• visitPredicate Predicate to determine if a node should be visited.
• includeDependencies If true, includes dependent nodes in the collection.

Implements SBDDataGraphNode::getNodes

---

function getPreviousPresentation

Returns the previous presentation.

SBDDocumentPresentation * SBDDocumentPresentation::getPreviousPresentation () const

Retrieves the previous sibling presentation.

Returns:

Pointer to the previous presentation, or nullptr if none exists.

---

function getType

Returns the data graph node type.

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

Retrieves the type of this node.

Returns:

The node type, which is SBNode::Presentation.

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 SBDDocumentPresentation::hasNode (
    SBNode::Type nodeType,
    bool selectedNodesOnly=false,
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Checks if the presentation contains a node of a specific type.

Parameters:

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

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 SBDDocumentPresentation::hasNode (
    const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(),
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Checks if any node satisfies a selection predicate.

Parameters:

• selectionPredicate Predicate to select nodes.
• visitPredicate Predicate to determine if a node should be visited.
• includeDependencies If true, includes dependent nodes in the check.

Returns:

true if a matching node exists; otherwise false.

Implements SBDDataGraphNode::hasNode

---

function initialize

Initializes the presentation.

virtual bool SBDDocumentPresentation::initialize () 

Returns:

true if initialization succeeds.

---

function isSerializable

Returns true __

virtual bool SBDDocumentPresentation::isSerializable () override const

Checks if the presentation is serializable.

Returns:

Always returns true, as presentations are serializable.

Implements SBDDataGraphNode::isSerializable

---

function print

Prints the presentation.

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

Prints information about the presentation and its children.

Parameters:

• offset Number of indentation levels to apply when printing.

Implements SBDDataGraphNode::print

---

function removeChild

Removes a child from the presentation.

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

Removes a child node from the presentation.

Parameters:

• node The child node to remove.

Returns:

true if the child was successfully removed; otherwise false.

---

function serialize

Serializes the presentation.

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

Serializes the presentation to the provided serializer.

Parameters:

• serializer The serializer used to write data.
• nodeIndexer Indexer mapping nodes to indices during serialization.
• sdkVersionNumber The SDK version number for compatibility.
• classVersionNumber The class version number for compatibility.

Implements SBDDataGraphNode::serialize

---

function setBeginFrame

Sets the begin frame.

void SBDDocumentPresentation::setBeginFrame (
    int frame
) 

Sets the beginning frame of the presentation.

Parameters:

• frame The new begin frame value.

Adjusts the end and current frames if necessary to maintain consistency.

---

function setCurrentFrame

Sets the current frame.

void SBDDocumentPresentation::setCurrentFrame (
    int frame
) 

Sets the current frame of the presentation.

Parameters:

• frame The new current frame value.

The frame is clamped to the range [beginFrame, endFrame] and updates child animations accordingly.

---

function setEndFrame

Sets the end frame.

void SBDDocumentPresentation::setEndFrame (
    int frame
) 

Sets the ending frame of the presentation.

Parameters:

• frame The new end frame value.

Adjusts the begin and current frames if necessary to maintain consistency.

---

function unserialize

Unserializes the presentation.

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

Deserializes the presentation from the provided serializer.

Parameters:

• serializer The serializer used to read data.
• nodeIndexer Indexer mapping indices to nodes during deserialization.
• sdkVersionNumber The SDK version number for compatibility.
• classVersionNumber The class version number for compatibility.

Implements SBDDataGraphNode::unserialize

---

function ~SBDDocumentPresentation

Destructs the presentation.

virtual SBDDocumentPresentation::~SBDDocumentPresentation () 

Releases resources associated with the presentation.

---

Protected Functions Documentation

function SBDDocumentPresentation [3/3]

Builds a presentation.

SBDDocumentPresentation::SBDDocumentPresentation (
    SBDDocumentPresentationData * dataPointer
) 

Constructs a presentation from the given data pointer.

Parameters:

• dataPointer Pointer to the internal data structure for the presentation.

---