|
| SB_DECLARE_DATA (SBDDocument) |
|
| SB_DECLARE_DATA (SBDDocumentFolder) |
|
| SBDDocumentFolder () |
| Constructs a folder.
|
|
| SBDDocumentFolder (const std::string &name) |
| Constructs a folder with name name .
|
|
virtual | ~SBDDocumentFolder () |
| Destructs the folder.
|
|
bool | isSerializable () const |
| Returns true.
|
|
virtual bool | initialize () |
| Initializes the folder.
|
|
SBPointerList< SBNode > const * | getChildren () const |
| Returns the children of the folder.
|
|
virtual bool | canAddChild (SBNode *node, SBNode *nextNode=0) const |
| Returns whether this node can add node as a child.
|
|
virtual bool | canAddChildType (SBNode::Type nodeType) const |
| Returns whether this node can add a node with type nodeType as a child.
|
|
virtual bool | canHaveDescendantType (SBNode::Type nodeType) const |
| Returns whether this node can have a node with type nodeType as a descendant.
|
|
virtual bool | addChild (SBNode *node, SBNode *nextNode=0) |
| Adds a child to the folder.
|
|
virtual bool | removeChild (SBNode *node) |
| Removes a child from the folder.
|
|
SBDDocumentFolder * | getNextFolder () const |
| Returns the next folder.
|
|
SBDDocumentFolder * | getPreviousFolder () const |
| Returns the previous folder.
|
|
SBPointerList< SBDDocumentFolder > const * | getFolderList () const |
| Returns the list of folders.
|
|
SBPointerList< SBMModel > const * | getModelList () const |
| Returns the list of models.
|
|
SBPointerList< SBMStructuralModel > const * | getStructuralModelList () const |
| Returns the list of structural models.
|
|
SBPointerList< SBMVisualModel > const * | getVisualModelList () const |
| Returns the list of visual models.
|
|
SBPointerList< SBMDynamicalModel > const * | getDynamicalModelList () const |
| Returns the list of dynamical models.
|
|
SBPointerList< SBMInteractionModel > const * | getInteractionModelList () const |
| Returns the list of interaction models.
|
|
SBPointerList< SBMPropertyModel > const * | getPropertyModelList () const |
| Returns the list of property models.
|
|
SBPointerList< SBSSimulator > const * | getSimulatorList () const |
| Returns the list of Simulators.
|
|
SBPointerList< SBDController > const * | getControllerList () const |
| Returns the list of controllers.
|
|
SBPointerList< SBNodeGroup > const * | getNodeGroupList () const |
| Returns the list of node groups.
|
|
SBPointerList< SBConformation > const * | getConformationList () const |
| Returns the list of conformations.
|
|
SBPointerList< SBPath > const * | getPathList () const |
| Returns the list of paths.
|
|
SBPointerList< SBLabel > const * | getLabelList () const |
| Returns the list of labels.
|
|
SBPointerList< SBNote > const * | getNoteList () const |
| Returns the list of notes.
|
|
SBPointerList< SBCamera > const * | getCameraList () const |
| Returns the list of cameras.
|
|
SBPointerList< SBAsset > const * | getAssetList () const |
| Returns the list of assets.
|
|
SBPointerList< SBAnimation > const * | getAnimationList () const |
| Returns the list of animations.
|
|
SBPointerList< SBPresentation > const * | getPresentationList () const |
| Returns the list of presentations.
|
|
SBUUID | getUUID () const |
| Returns the folder UUID.
|
|
void | setUUID (const SBUUID &uuid) |
| sets the folder UUID
|
|
virtual unsigned int | getOpacity () const |
| Returns the opacity.
|
|
virtual void | setOpacity (unsigned int opacity) |
| Sets the opacity.
|
|
virtual unsigned int | getMinimumOpacity () const |
| Returns the minimum opacity.
|
|
virtual unsigned int | getTransparency () const |
| Returns the transparency.
|
|
virtual void | setTransparency (unsigned int transparency) |
| Sets the transparency.
|
|
virtual unsigned int | getMaximumTransparency () const |
| Returns the maximum transparency.
|
|
virtual void | getNodes (SBNodeIndexer &nodeIndexer, SBNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const |
| Collects nodes into nodeIndexer , based on a nodeType , a selection status and a visitPredicate , with our without dependencies.
|
|
virtual void | getNodes (SBNodeIndexer &nodeIndexer, const SBNodePredicate &selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const |
| Returns some nodes.
|
|
virtual void | forEachNodeDepthFirst (void(*action)(SBNode *node)) |
| Performs action action on each node of this document.
|
|
virtual void | forEachNodeDepthFirst (SBCClass *object, void(SBCClass::*action)(SBNode *node)) |
| Performs action action of object object on each node of this document.
|
|
void | connectDocumentSignalToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBDocumentEvent *), SBCReferenceTarget *nextReferenceTarget=0, void(SBCReferenceTarget::*nextFunctionPointer)(SBDocumentEvent *)=0) |
| Connects the document signal to a slot.
|
|
bool | documentSignalIsConnectedToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBDocumentEvent *)) const |
| Returns true if and only if the document signal is connected to the slot.
|
|
void | disconnectDocumentSignalFromSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBDocumentEvent *)) |
| Disconnects the document signal from a slot.
|
|
unsigned int | getNumberOfChains () |
| Returns the number of chains.
|
|
unsigned int | getNumberOfMolecules () |
| Returns the number of molecules.
|
|
unsigned int | getNumberOfResidues () |
| Returns the number of residues.
|
|
unsigned int | getNumberOfSegments () |
| Returns the number of segments.
|
|
unsigned int | getNumberOfStructuralGroups () |
| Returns the number of structural groups.
|
|
unsigned int | getNumberOfStructuralModels () |
| Returns the number of structural models.
|
|
unsigned int | getNumberOfAtoms () |
| Returns the number of atoms.
|
|
unsigned int | getNumberOfCarbons () |
| Returns the number of carbons.
|
|
unsigned int | getNumberOfHydrogens () |
| Returns the number of hydrogens.
|
|
unsigned int | getNumberOfNitrogens () |
| Returns the number of nitrogens.
|
|
unsigned int | getNumberOfOxygens () |
| Returns the number of oxygens.
|
|
unsigned int | getNumberOfSulfurs () |
| Returns the number of sulfurs.
|
|
unsigned int | getNumberOfOtherAtoms () |
| Returns the number of other atoms.
|
|
int | getSumOfFormalCharges () |
| Returns the sum of formal charges.
|
|
float | getSumOfPartialCharges () |
| Returns the sum of partial charges.
|
|
SBQuantity::mass | getMolecularWeight () |
| Returns the molecular weight.
|
|
| SB_DECLARE_DATA (SBDDataGraphNode) |
|
SBDDataGraphNode * | getParent () const |
| Returns the parent of the node. More...
|
|
SBDDataGraphNode * | getThisNode () const |
| Returns the pointer to this node. More...
|
|
SBDDataGraphNode * | getNextNode () const |
| Returns the pointer to the next node in the children of the node's parent. More...
|
|
SBDDataGraphNode * | getPreviousNode () const |
| Returns the pointer to the previous node in the children of the node's parent. More...
|
|
SBDDataGraphNode * | getNextNode (SBDDataGraphNode::Type nodeType) const |
| Returns the pointer to the next node with type nodeType in the children of the node's parent. More...
|
|
SBDDataGraphNode * | getPreviousNode (SBDDataGraphNode::Type nodeType) const |
| Returns the pointer to the previous node with type nodeType in the children of the node's parent. More...
|
|
SBDDocument * | getDocument () const |
| Returns the document the node belongs to. More...
|
|
virtual bool | canAddChild (SBDDataGraphNode *node, SBDDataGraphNode *nextNode=0) const |
| Returns whether this node can add node as a child. More...
|
|
virtual bool | addChild (SBDDataGraphNode *node, SBDDataGraphNode *nextNode=0) |
| Adds a child to the node. More...
|
|
virtual bool | removeChild (SBDDataGraphNode *node) |
| Removes a child from the node. More...
|
|
bool | hasOneOf (const SBNodeIndexer &nodeIndexer) const |
| Returns true if and only if this node is one of the nodes of the nodeIndexer , or is the ancestor of one of them. More...
|
|
bool | descendsFrom (SBDDataGraphNode *node) const |
| Returns true if and only if this node is node , or descends from it. More...
|
|
bool | descendsFrom (const SBNodeIndexer &nodeIndexer) const |
| Returns true if and only if this node is one of the nodes of the nodeIndexer , or descends from one of them. More...
|
|
bool | descendsFrom (SBPointerIndexer< SBDDataGraphNode > *nodePointerIndexer) const |
| Returns true if and only if this node is one of the nodes of the nodePointerIndexer , or descends from one of them. More...
|
|
bool | isIn (SBDDataGraphNode *node) const |
| Returns true if and only if this node is node , or descends from it, or belongs to a group stored in node . More...
|
|
bool | isIn (const SBNodeIndexer &nodeIndexer) const |
| Returns true if and only if this node is one of the nodes of the nodeIndexer , or descends from one of them, or belongs to a group stored in one of the nodes of the nodeIndexer . More...
|
|
bool | isIn (SBPointerIndexer< SBDDataGraphNode > *nodePointerIndexer) const |
| Returns true if and only if this node is one of the nodes of the nodePointerIndexer , or descends from one of them, or belongs to a group stored in of the nodes of the nodePointerIndexer . More...
|
|
bool | isOneOf (const SBNodeIndexer &nodeIndexer) const |
| Returns true if and only if this node is one of the nodes of the nodeIndexer . More...
|
|
bool | isOneOf (SBPointerIndexer< SBDDataGraphNode > *nodePointerIndexer) const |
| Returns true if and only if this node is one of the nodes of the nodePointerIndexer . More...
|
|
SBDDataGraphNode * | getRoot () const |
| Returns the root of the hierarchy the node belongs to. More...
|
|
unsigned int | getNodeIndex () const |
| Returns the node index (unique in the whole data graph, but non-persistent) More...
|
|
std::string | getTypeString (bool humanReadable=false) const |
| Returns a string describing the type of the data graph node. More...
|
|
virtual std::string const & | getName () const |
| Returns the name of the node.
|
|
virtual void | setName (const std::string &name) |
| Sets the name of the node. More...
|
|
bool | isType (Type type) const |
| Returns true when the type of the node corresponds to type .
|
|
bool | isModel () const |
| Returns true when the node is a model.
|
|
bool | isStructuralNode () const |
| Returns true when the node is a structural node.
|
|
bool | isStructuralModel () const |
| Returns true when the node is a structural model.
|
|
bool | isVisualModel () const |
| Returns true when the node is a visual model.
|
|
bool | isDynamicalModel () const |
| Returns true when the node is a dynamical model.
|
|
bool | isInteractionModel () const |
| Returns true when the node is a interaction model.
|
|
bool | isPropertyModel () const |
| Returns true when the node is a property model.
|
|
bool | isMesh () const |
| Returns true when the node is a mesh.
|
|
bool | isSimulator () const |
| Returns true when the node is a simulator.
|
|
bool | isStructuralParticle () const |
| Returns true when the node is a structural particle (an atom or a pseudo-atom)
|
|
virtual bool | isLocked () const |
| Returns whether the node is locked.
|
|
virtual bool | getLockedFlag () const |
| Returns the locked flag.
|
|
virtual void | setLockedFlag (bool flag) |
| Sets the locked flag.
|
|
bool | isCreated () const |
| Returns true if and only if the node is created. More...
|
|
void | create () |
| Creates the node. More...
|
|
bool | isErased () const |
| Returns true if and only if the node is erased. More...
|
|
void | erase () |
| Erases the node. More...
|
|
unsigned int | getFlags () const |
| Returns the flags. More...
|
|
unsigned int | getInheritedFlags () const |
| Returns the inherited flags. More...
|
|
bool | isSelected () const |
| Returns whether the node is selected. More...
|
|
bool | getSelected () const |
| Returns whether the node is selected.
|
|
bool | getSelectionFlag () const |
| Returns the selection flag. More...
|
|
void | setSelectionFlag (bool flag) |
| Sets the selection flag. More...
|
|
bool | isVisible () const |
| Returns whether the node is visible. More...
|
|
bool | getVisible () const |
| Returns whether the node is visible.
|
|
bool | getVisibilityFlag () const |
| Returns the visibility flag. More...
|
|
void | setVisibilityFlag (bool flag) |
| Sets the visibility flag. More...
|
|
bool | isHighlighted () const |
| Returns whether the node is highlighted. More...
|
|
bool | getHighlightingFlag () const |
| Returns the highlighting flag. More...
|
|
void | setHighlightingFlag (bool flag) |
| Sets the highlighting flag. More...
|
|
virtual void | display (RenderingPass renderingPass) |
| Displays the node. More...
|
|
virtual void | display () |
| Displays the node (deprecated) More...
|
|
virtual void | displayForShadow () |
| Displays the node for shadowing purposes (deprecated) More...
|
|
virtual void | displayForSelection () |
| Displays the node for selection purposes (deprecated) More...
|
|
virtual bool | hasOpacityRange () const |
| Returns whether the node has the opacity range.
|
|
virtual unsigned int | getDefaultOpacity () const |
| Returns the default opacity.
|
|
virtual unsigned int | getMaximumOpacity () const |
| Returns the maximum opacity.
|
|
virtual unsigned int | getOpacitySingleStep () const |
| Returns the opacity single step.
|
|
virtual std::string | getOpacitySuffix () const |
| Returns the opacity suffix.
|
|
virtual bool | hasTransparencyRange () const |
| Returns whether the node has the transparency range.
|
|
virtual unsigned int | getDefaultTransparency () const |
| Returns the default transparency.
|
|
virtual unsigned int | getMinimumTransparency () const |
| Returns the minimum transparency.
|
|
virtual unsigned int | getTransparencySingleStep () const |
| Returns the transparency single step.
|
|
virtual std::string | getTransparencySuffix () const |
| Returns the transparency suffix.
|
|
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.
|
|
bool | addMaterial (SBDDataGraphNodeMaterial *material) |
| Adds a material. More...
|
|
bool | removeMaterial () |
| Removes the material. More...
|
|
bool | hasMaterial () const |
| Returns whether the node has a material (by itself, or inherited)
|
|
bool | ownsMaterial () const |
| Returns whether the node owns a material.
|
|
SBDDataGraphNodeMaterial * | getMaterial () const |
| Returns the material. More...
|
|
SBDDataGraphNode * | getMaterialOwner () const |
| Returns the node whose material is inherited. More...
|
|
void | connectBaseSignalToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *), SBCReferenceTarget *nextReferenceTarget=0, void(SBCReferenceTarget::*nextFunctionPointer)(SBBaseEvent *)=0) |
| Connects the base signal to a slot. More...
|
|
bool | baseSignalIsConnectedToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *)) const |
| Returns true when the base signal is connected to a slot.
|
|
void | disconnectBaseSignalFromSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *)) |
| Disconnects the base signal from a slot.
|
|
unsigned int | countNodes (SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const |
| Collects nodes into nodeIndexer , based on a nodeType , a selection status and a visitPredicate , with our without dependencies. More...
|
|
unsigned int | countNodes (const SBNodePredicate &selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const |
| Collects nodes into nodeIndexer , based on a selectionPredicate and a visitPredicate , with our without dependencies. More...
|
|
virtual void | forEachNodeDepthFirst (void(*action)(SBDDataGraphNode *node)) |
| Performs an action on each node.
|
|
virtual void | forEachNodeDepthFirst (SBCClass *object, void(SBCClass::*action)(SBDDataGraphNode *node)) |
| Performs an action on each node.
|
|
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. More...
|
|
| SBCReferenceTarget () |
|
virtual | ~SBCReferenceTarget () |
|
unsigned int | getMemoryFootprint () const |
|
void | printReferencesToOwners () const |
|
This class describes a document. A document may contain folders, cameras, groups, conformations and paths.
SAMSON Elements access the active document through SAMSON:
The set of selected nodes is accessible from the document:
SBPointerIndexer<SBNode> const* selectedNodes=activeDocument->getSelectedNodes();
The index cannot be modified, because SAMSON needs to perform bookkeeping when managing selected nodes, so the selection is manipulated either by modifying the selection flag of a node:
atom->setSelectionFlag(true);
atom->setSelectionFlag(false);
or by modyfing the document selection itself:
document->addNodeToSelection(atom);
document->removeNodeFromSelection(atom);
Whenever the selection flag of a node changes, through either one of these methods, a SelectionFlagChanged
base signal is emitted by the node and the document (thus, adding a node twice to a selection, for example, emits a signal only once).
Note that you should always turn the Undo system on when modifying the selection:
atom->setSelectionFlag(true);
Short name: SBDocument
- See also
- SBDDocumentFolder
-
SBCamera
-
SBDDataGraphNodeGroup
-
SBMStructuralModelConformation
-
SBMStructuralModelPath
-
Signals and slots