Class SBMVisualModelMesh#
ClassList > SBMVisualModelMesh
This class describes a mesh, i.e. More...
#include <SBMVisualModelMesh.hpp>
Inherits the following classes: SBMVisualModel
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 |
|---|---|
| SBMVisualModelMesh () Builds a mesh. |
|
| SBMVisualModelMesh (const SBVector< SBMVisualModelSurface * > & surfaceVector) Builds a mesh. |
|
| virtual bool | canCreateMesh () override const Returns true __ |
| virtual SBMVisualModelMesh * | clone () override Returns a copy of the node and its descendants. |
| virtual void | collectAmbientOcclusion (const SBPosition3 & boxOrigin, const SBPosition3 & boxSize, unsigned int nCellsX, unsigned int nCellsY, unsigned int nCellsZ, float * ambientOcclusionData) override To collect ambient occlusion data. |
| virtual SBMVisualModelMesh * | createMesh () override Returns a clone of the mesh. |
| virtual void | expandBounds (SBIAPosition3 & bounds) override const Expands the bounds to make sure the visual model fits inside them. |
| unsigned int | getDefaultDiffuseColorReplacement () const Returns the default value of the diffuse color replacement. |
| SBVector3 const & | getDefaultScale () const Returns the default scale of the mesh. |
| unsigned int | getDiffuseColorReplacement () const Returns the diffuse color replacement. |
| unsigned int | getDiffuseColorReplacementSingleStep () const Returns the single step value of the diffuse color replacement. |
| std::string | getDiffuseColorReplacementSuffix () const Returns the suffix. |
| unsigned int | getMaximumDiffuseColorReplacement () const Returns the maximum value of the diffuse color replacement. |
| unsigned int | getMinimumDiffuseColorReplacement () const Returns the minimum value of the diffuse color replacement. |
| virtual SBDDataGraphNode::Type | getModelType () override const Returns the model type. |
| SBMVisualModelMesh * | getNextMesh () const Returns the next mesh in the parent. |
| SBMatrix33 const & | getOrientation () const Returns the orientation of the mesh. |
| SBPosition3 const & | getPosition () const Returns the position of the mesh. |
| SBMVisualModelMesh * | getPreviousMesh () const Returns the previous mesh in the parent. |
| SBVector3 const & | getScale () const Returns the scale of the mesh. |
| SBPointerIndexer< SBSurface > & | getSurfaceIndexer () const Returns the indexer of surfaces. |
| SBSpatialTransform const & | getTransform () const Returns the spatial transform of the mesh. |
| virtual SBDDataGraphNode::Type | getType () override const Returns the node type ( SBNode::Mesh ) |
| bool | hasDiffuseColorReplacementRange () const Returns true __ |
| virtual bool | isSerializable () override const Returns true when the class is serializable. |
| virtual void | print (unsigned int offset=0) override const Prints debugging information. |
| void | rotate (const SBVector3 & axis, const SBQuantity::dimensionless & angle) Rotates the mesh. |
| void | scale (const SBVector3 & scale) Scales the mesh. |
| 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. |
| void | setDiffuseColorReplacement (unsigned int diffuseColorReplacement) Sets the diffuse color replacement. |
| void | setOrientation (const SBMatrix33 & orientation) Sets the orientation of the mesh. |
| void | setOrientation (SBMatrix33 const & newOrientation, SBMatrix33 const & oldOrientation) Sets the newOrientation and theoldOrientation of the mesh. |
| void | setPosition (const SBPosition3 & position) Sets the position of the mesh. |
| void | setPosition (SBPosition3 const & newPosition, SBPosition3 const & oldPosition) Sets the newPosition and theoldPosition of the mesh. |
| void | setScale (const SBVector3 & scale) Sets the scale of the mesh. |
| void | setScale (SBVector3 const & newScale, SBVector3 const & oldScale) Sets the newScale and theoldScale of the mesh. |
| void | setTransform (const SBSpatialTransform & transform) Sets the spatial transform of the mesh. |
| void | setTransform (SBSpatialTransform const & newTransform, SBSpatialTransform const & oldTransform) Sets the newTransform and theoldTransform of the mesh. |
| void | transform (const SBSpatialTransform & transform) Applies a spatial transform to the mesh. |
| void | translate (const SBLength3 & translation) Translates the mesh. |
| 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 | ~SBMVisualModelMesh () Deletes the mesh. |
Public Functions inherited from SBMVisualModel#
See SBMVisualModel
| Type | Name |
|---|---|
| SBMVisualModel () Builds a visual model. |
|
| SBMVisualModel (const SBNodeIndexer & nodeIndexer, const SBValueMap & parameterMap=SBValueMap{}) Builds a visual model. |
|
| virtual bool | canCreateMesh () const Returns true if the visual model can create a mesh. |
| virtual void | changed () Emits the VisualModelChanged event. |
| virtual void | collectAmbientOcclusion (const SBPosition3 & boxOrigin, const SBPosition3 & boxSize, unsigned int nCellsX, unsigned int nCellsY, unsigned int nCellsZ, float * ambientOcclusionData) To collect ambient occlusion data. |
| void | connectVisualSignalToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBVisualEvent *) functionPointer, SBCReferenceTarget * nextReferenceTarget=0, void(SBCReferenceTarget::*)(SBVisualEvent *) nextFunctionPointer=0) Connects the visual signal to a slot. |
| virtual SBMVisualModelMesh * | createMesh () Returns a mesh constructed from this visual model. |
| void | disconnectVisualSignalFromSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBVisualEvent *) functionPointer) Disconnects the visual signal from a slot. |
| virtual void | expandBounds (SBIAPosition3 & bounds) const Expands the bounds to make sure the visual model fits inside them. |
| SBPointerIndexer< SBGeometryArray > & | getGeometryArrayIndexer () const Returns the indexer of geometry arrays. |
| virtual SBDDataGraphNode::Type | getModelType () override const Returns the model type. |
| virtual SBDDataGraphNode::Type | getType () override const Returns the node type ( SBNode::VisualModel ) |
| virtual bool | isSerializable () override const Returns true when the class is serializable. |
| virtual void | print (unsigned int offset=0) override const Prints debugging information. |
| 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. |
| bool | visualSignalIsConnectedToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBVisualEvent *) functionPointer) const Returns true if and only if the visual signal is connected to the slot. |
| virtual | ~SBMVisualModel () Deletes the visual model. |
Public Functions inherited from SBMModel#
See SBMModel
| Type | Name |
|---|---|
| SB_NODE_GETTER_0 (SB_SBMMODEL_EXPORT, SBDDataGraphNode::Type, GetModelType) |
|
| SB_NODE_PREDICATE_1 (SB_SBMMODEL_EXPORT, IsModelType, SBDDataGraphNode::Type) |
|
| void | clearSourceFileName () Clears the name of the file associated to the model. |
| virtual SBMModel * | clone () override Returns a copy of the node and its descendants. |
| virtual SBDDataGraphNode::Type | getModelType () const Returns the model type. |
| SBMModel * | getNextModel () const Returns the next model in the parent. |
| virtual unsigned int | getOpacity () override const Returns the opacity. |
| SBMModel * | getPreviousModel () const Returns the previous model in the parent. |
| bool | getShadowingFlag () const Returns whether the model casts shadows. |
| const std::string & | getSourceFileName () const Returns the name of the file associated to the model. |
| virtual unsigned int | getTransparency () override const Returns the transparency. |
| virtual SBDDataGraphNode::Type | getType () override const Returns the type of the data graph node. |
| bool | hasSourceFileName () const Returns true when the model has the source file name set. |
| virtual bool | isSerializable () override const Returns true __ |
| virtual void | print (unsigned int offset=0) override const Prints debugging information. |
| 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 | setOpacity (unsigned int opacity) override Sets the opacity. |
| void | setShadowingFlag (bool shadowingFlag) Sets whether the model casts shadows. |
| void | setSourceFileName (const std::string & fileName) Sets the name of the file associated to the model. |
| virtual void | setTransparency (unsigned int transparency) override Sets the transparency. |
| virtual void | unserialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override Unserializes the node. |
| virtual | ~SBMModel () Delete the model. |
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#
| 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#
| Type | Name |
|---|---|
| SBCReferenceTargetData * | dataPointer A pointer to the private data. |
Protected Functions inherited from SBMVisualModel#
See SBMVisualModel
| Type | Name |
|---|---|
| SBMVisualModel (SBMVisualModelData * dataPointer) Builds a visual model. |
Protected Functions inherited from SBMModel#
See SBMModel
| Type | Name |
|---|---|
| SBMModel () Builds a model. |
|
| SBMModel (SBMModelData * dataPointer) Builds a model. |
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#
| Type | Name |
|---|---|
| SBCReferenceTarget (SBCReferenceTargetData * dataPointer) Protected constructor. |
|
| void | removeAllReferenceOwners () Stops all the reference owners from referencing this reference target. |
Detailed Description#
a group of surfaces.
Short name: SBMesh
Public Functions Documentation#
function SBMVisualModelMesh [1/2]#
Builds a mesh.
Constructs an empty mesh.
Creates a new mesh with no surfaces.
function SBMVisualModelMesh [2/2]#
Builds a mesh.
SBMVisualModelMesh::SBMVisualModelMesh (
const SBVector< SBMVisualModelSurface * > & surfaceVector
)
Constructs a mesh with the given surfaces.
Initializes the mesh with the provided vector of surface pointers.
Parameters:
surfaceVectorVector of surface pointers to be added to the mesh.
function canCreateMesh#
Returns true __
Indicates whether a mesh can be created from this object.
Returns:
True, as mesh creation is supported.
Implements SBMVisualModel::canCreateMesh
function clone#
Returns a copy of the node and its descendants.
Creates a copy of this mesh and its descendants.
Returns:
A new mesh instance that is a clone of this mesh.
Implements SBMModel::clone
function collectAmbientOcclusion#
To collect ambient occlusion data.
virtual void SBMVisualModelMesh::collectAmbientOcclusion (
const SBPosition3 & boxOrigin,
const SBPosition3 & boxSize,
unsigned int nCellsX,
unsigned int nCellsY,
unsigned int nCellsZ,
float * ambientOcclusionData
) override
Collects ambient occlusion data for the mesh.
Parameters:
boxOriginOrigin of the sampling box.boxSizeSize of the sampling box.nCellsXNumber of cells along the X axis.nCellsYNumber of cells along the Y axis.nCellsZNumber of cells along the Z axis.ambientOcclusionDataPointer to the buffer where AO data will be stored.
Implements SBMVisualModel::collectAmbientOcclusion
function createMesh#
Returns a clone of the mesh.
Creates a new mesh instance by cloning this mesh.
Returns:
Pointer to the newly created mesh.
Implements SBMVisualModel::createMesh
function expandBounds#
Expands the bounds to make sure the visual model fits inside them.
Expands the given bounds to include the mesh geometry.
Parameters:
boundsThe bounds to expand.
Implements SBMVisualModel::expandBounds
function getDefaultDiffuseColorReplacement#
Returns the default value of the diffuse color replacement.
Returns the default diffuse color replacement value.
Returns:
Default value as a percentage.
function getDefaultScale#
Returns the default scale of the mesh.
Returns the default scale value for meshes.
Returns:
Reference to the default scale (typically unit scale).
function getDiffuseColorReplacement#
Returns the diffuse color replacement.
Retrieves the current diffuse color replacement value.
Returns:
Diffuse color replacement as an integer percentage.
function getDiffuseColorReplacementSingleStep#
Returns the single step value of the diffuse color replacement.
Returns the step increment for the diffuse color replacement.
Returns:
Single step value as a percentage.
function getDiffuseColorReplacementSuffix#
Returns the suffix.
Returns the suffix used for displaying the diffuse color replacement.
Returns:
Suffix string.
function getMaximumDiffuseColorReplacement#
Returns the maximum value of the diffuse color replacement.
Returns the maximum allowed diffuse color replacement value.
Returns:
Maximum value as a percentage.
function getMinimumDiffuseColorReplacement#
Returns the minimum value of the diffuse color replacement.
Returns the minimum allowed diffuse color replacement value.
Returns:
Minimum value as a percentage.
function getModelType#
Returns the model type.
Returns the model type identifier for this mesh.
Returns:
The type enum value representing a visual model.
Implements SBMVisualModel::getModelType
function getNextMesh#
Returns the next mesh in the parent.
Returns the next mesh in the parent container.
Returns:
Pointer to the next mesh, or nullptr if none exists.
function getOrientation#
Returns the orientation of the mesh.
Returns the orientation matrix of the mesh.
Returns:
Reference to the orientation matrix.
function getPosition#
Returns the position of the mesh.
Retrieves the current position of the mesh.
Returns:
Reference to the mesh position.
function getPreviousMesh#
Returns the previous mesh in the parent.
Returns the previous mesh in the parent container.
Returns:
Pointer to the previous mesh, or nullptr if none exists.
function getScale#
Returns the scale of the mesh.
Returns the current scale of the mesh.
Returns:
Reference to the scale vector.
function getSurfaceIndexer#
Returns the indexer of surfaces.
Returns the indexer containing references to the mesh's surfaces.
Returns:
Reference to the surface indexer.
function getTransform#
Returns the spatial transform of the mesh.
Returns the spatial transform applied to the mesh.
Returns:
Reference to the spatial transform.
function getType#
Returns the node type ( SBNode::Mesh )
Returns the node type identifier for this mesh.
Returns:
The type enum value representing a mesh node.
Implements SBMVisualModel::getType
function hasDiffuseColorReplacementRange#
Returns true __
Indicates whether a range is defined for the diffuse color replacement.
Returns:
true if a range is defined; otherwise false.
function isSerializable#
Returns true when the class is serializable.
Indicates whether the mesh class supports serialization.
Returns:
true, as the mesh is serializable.
Implements SBMVisualModel::isSerializable
function print#
Prints debugging information.
Prints debugging information for the mesh.
Parameters:
offsetNumber of tabs to indent the output.
Implements SBMVisualModel::print
function rotate#
Rotates the mesh.
Rotates the mesh around a given axis by a specified angle.
Parameters:
axisThe axis of rotation.angleThe rotation angle (dimensionless).
function scale#
Scales the mesh.
Scales the mesh by the given scale factors.
Parameters:
scaleThe scaling vector.
function serialize#
Serializes the node.
virtual void SBMVisualModelMesh::serialize (
SBCSerializer * serializer,
const SBNodeIndexer & nodeIndexer,
const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) override const
Serializes the mesh to the provided serializer.
Writes the mesh's data, including transformation, opacity, diffuse color replacement, surfaces, and textures, to the serializer. The exact data written may depend on the SDK and class version numbers.
Parameters:
serializerPointer to the serializer used for writing data.nodeIndexerIndexer for nodes referenced during serialization.sdkVersionNumberVersion number of the SDK, used for compatibility handling.classVersionNumberVersion number of the class, used for compatibility handling.
Implements SBMVisualModel::serialize
function setDiffuseColorReplacement#
Sets the diffuse color replacement.
Sets the diffuse color replacement value.
Parameters:
diffuseColorReplacementThe new diffuse color replacement (percentage).
function setOrientation [1/2]#
Sets the orientation of the mesh.
Sets the orientation of the mesh to the specified matrix.
Parameters:
orientationThe new orientation matrix.
function setOrientation [2/2]#
Sets the newOrientation and theoldOrientation of the mesh.
void SBMVisualModelMesh::setOrientation (
SBMatrix33 const & newOrientation,
SBMatrix33 const & oldOrientation
)
Sets the orientation of the mesh.
Parameters:
newOrientationThe new orientation to apply.oldOrientationThe previous orientation.
function setPosition [1/2]#
Sets the position of the mesh.
Sets the position of the mesh.
Parameters:
positionThe new position.
function setPosition [2/2]#
Sets the newPosition and theoldPosition of the mesh.
void SBMVisualModelMesh::setPosition (
SBPosition3 const & newPosition,
SBPosition3 const & oldPosition
)
Sets the position of the mesh, providing old and new positions.
Parameters:
newPositionThe new position.oldPositionThe previous position.
function setScale [1/2]#
Sets the scale of the mesh.
Sets the scale of the mesh to a new value.
Parameters:
scaleThe new scale vector to apply.
function setScale [2/2]#
Sets the newScale and theoldScale of the mesh.
Sets the scale of the mesh, specifying both the new and old scale values.
Parameters:
newScaleThe new scale vector to apply.oldScaleThe previous scale vector (used for undo operations).
function setTransform [1/2]#
Sets the spatial transform of the mesh.
Sets the spatial transform of the mesh.
Parameters:
transformThe new spatial transform to apply.
function setTransform [2/2]#
Sets the newTransform and theoldTransform of the mesh.
void SBMVisualModelMesh::setTransform (
SBSpatialTransform const & newTransform,
SBSpatialTransform const & oldTransform
)
Sets the spatial transform of the mesh, specifying both new and old values.
Parameters:
newTransformThe new spatial transform to apply.oldTransformThe previous spatial transform (used for undo operations).
function transform#
Applies a spatial transform to the mesh.
Applies a spatial transform to the mesh, concatenating it with the current transform.
Parameters:
transformThe transform to apply.
function translate#
Translates the mesh.
Translates the mesh by the given vector.
Parameters:
translationThe translation vector.
function unserialize#
Unserializes the node.
virtual void SBMVisualModelMesh::unserialize (
SBCSerializer * serializer,
const SBNodeIndexer & nodeIndexer,
const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) override
Deserializes the mesh from a serializer.
Parameters:
serializerThe serializer used to read the data.nodeIndexerIndexer for nodes during deserialization.sdkVersionNumberThe SDK version number of the serialized data.classVersionNumberThe class version number of the serialized data.
Implements SBMVisualModel::unserialize
function ~SBMVisualModelMesh#
Deletes the mesh.
Destroys the mesh and releases its resources.