Simplygon 9 Documentation

# class SceneBone

SceneBone is the bone node in the simplygon scene graph

# Properties

Property Description
IsFrozen The IsFrozen flag. If set, the node will not be modified by processing modules.
IsModified If set, the node is new, copied, or modified by processing modules. This can be useful to track modifications in the scene graph.
IsVisible The IsVisible flag. If set, the node is visible.
NodeGUID The unique id for this node.
OriginalName The OriginalName parameter which can be used to specify the original name of a node, for debugging of merging purposes. This parameter is not copied or cloned, and is not used internally by Simplygon.

# Methods

Method Description
AddChild Adds a child node to this node. If the child is already a child of another node, it is removed from this node.
CalculateExtents Calculates the axis-aligned bounding box of the node and all its children. If the node tree contains no geometric data, or all data is hidden, the bounding box is not calcluated, and the method returns false.
CollectAllChildBones Looks through the sub-tree and collects the IDs of the bones found.
CreateChildMesh Creates a SceneMesh node as a child node to this node.
CreateChildPlane Creates a ScenePlane node as a child node to this node.
EvaluateDefaultGlobalTransformation Evaluates the default global transformation of the node, regardless of node animation.
FindNamedChild Finds the first child that has the name.
GetBoneId The BoneId.
GetChild Get a pointer to the i:th child of this node.
GetChildCount The number of direct children of this node.
GetClass Get the name of the SceneBone class.
GetInf The inferior (minimum) extent of the node.
GetParent The parent node of this node.
GetParentBone Looks through the hierarchy and fetches the previous BoneNode. If none is found, this is a Root-Bone-Node. -1 means it has no parent, otherwise, the ID is the parent ID.
GetPath The path to this node in the scene. Please note that only paths where each node has a name can be used to get to the node using the path.
GetRelativeTransform The relative transformation of this node.
GetScene The scene object of the node.
GetSup The superior (maximum) extent of the node.
HasChild Returns true if the node has the specified child.
IsA Returns true if SceneBone is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the SceneBone object is invalid.
NewClone Clones this node tree (this node and all the descendants of this node) and returns the cloned top node. Please note that the copy is not added to any scene, and can be added anywhere. Also note that the clone shares all data pointers with the original nodes, such as geometry data objects.
NewCopy Deep copies this node tree (this node and all the descendants of this node) and returns the copy top node. Please note that the copy is not added to any scene, and can be added anywhere.
RemoveChild Removes a child from the node.
RemoveChildren Removes all children of this node.
RemoveFromParent Removes this node from its parent.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spSceneBone, and if this is the case, returns the object cast into spSceneBone.

# Properties details

# IsFrozen

The IsFrozen flag. If set, the node will not be modified by processing modules.

    # IsModified

    If set, the node is new, copied, or modified by processing modules. This can be useful to track modifications in the scene graph.

      # IsVisible

      The IsVisible flag. If set, the node is visible.

        # NodeGUID

        The unique id for this node.

          # OriginalName

          The OriginalName parameter which can be used to specify the original name of a node, for debugging of merging purposes. This parameter is not copied or cloned, and is not used internally by Simplygon.

            # Methods details

            # AddChild

            Adds a child node to this node. If the child is already a child of another node, it is removed from this node.

              # CalculateExtents

              Calculates the axis-aligned bounding box of the node and all its children. If the node tree contains no geometric data, or all data is hidden, the bounding box is not calcluated, and the method returns false.

                # CollectAllChildBones

                Looks through the sub-tree and collects the IDs of the bones found.

                  # CreateChildMesh

                  Creates a SceneMesh node as a child node to this node.

                    # CreateChildPlane

                    Creates a ScenePlane node as a child node to this node.

                      # EvaluateDefaultGlobalTransformation

                      Evaluates the default global transformation of the node, regardless of node animation.

                        # FindNamedChild

                        Finds the first child that has the name.

                          # GetBoneId

                          The BoneId.

                            # GetChild

                            Get a pointer to the i:th child of this node.

                              # GetChildCount

                              The number of direct children of this node.

                                # GetClass

                                Get the name of the SceneBone class.

                                  # GetInf

                                  The inferior (minimum) extent of the node.

                                    # GetParent

                                    The parent node of this node.

                                      # GetParentBone

                                      Looks through the hierarchy and fetches the previous BoneNode. If none is found, this is a Root-Bone-Node. -1 means it has no parent, otherwise, the ID is the parent ID.

                                        # GetPath

                                        The path to this node in the scene. Please note that only paths where each node has a name can be used to get to the node using the path.

                                          # GetRelativeTransform

                                          The relative transformation of this node.

                                            # GetScene

                                            The scene object of the node.

                                              # GetSup

                                              The superior (maximum) extent of the node.

                                                # HasChild

                                                Returns true if the node has the specified child.

                                                  # IsA

                                                  Returns true if SceneBone is a or is a descendant of the class named as the type parameter.

                                                    # IsNull

                                                    Returns true if the SceneBone object is invalid.

                                                      # NewClone

                                                      Clones this node tree (this node and all the descendants of this node) and returns the cloned top node. Please note that the copy is not added to any scene, and can be added anywhere. Also note that the clone shares all data pointers with the original nodes, such as geometry data objects.

                                                        # NewCopy

                                                        Deep copies this node tree (this node and all the descendants of this node) and returns the copy top node. Please note that the copy is not added to any scene, and can be added anywhere.

                                                          # RemoveChild

                                                          Removes a child from the node.

                                                            # RemoveChildren

                                                            Removes all children of this node.

                                                              # RemoveFromParent

                                                              Removes this node from its parent.

                                                                # Static methods details

                                                                # IsClassA

                                                                Returns true if the class is a or is a descendant of the class named as the type parameter.

                                                                  # SafeCast

                                                                  SafeCast makes sure the input object is of a class that can be cast into spSceneBone, and if this is the case, returns the object cast into spSceneBone.

                                                                    ← SceneCamera →