Simplygon 10.3.5200.0
class ScenePlane
ScenePlane is the plane node in the simplygon scene graph that can be used in various processes, for example as a cutting plane in the RemeshingProcessor.
Properties
| Property | Description |
|---|---|
| IsModified | If set, the node is new, copied, or modified by processing modules. This can be useful to track modifications in the scene graph. (Inherited from SceneNode) |
| IsVisible | The IsVisible flag. If set, the node is visible. (Inherited from SceneNode) |
| Name | The name of the ScenePlane object. (Inherited from Object) |
| NodeGUID | The unique id for this node. (Inherited from SceneNode) |
| 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. (Inherited from SceneNode) |
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. (Inherited from SceneNode) |
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| 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 calculated, and the method returns false. (Inherited from SceneNode) |
| CreateChildMesh | Creates a SceneMesh node as a child node to this node. (Inherited from SceneNode) |
| CreateChildPlane | Creates a ScenePlane node as a child node to this node. (Inherited from SceneNode) |
| EvaluateDefaultGlobalTransformation | Evaluates the default global transformation of the node, regardless of node animation. (Inherited from SceneNode) |
| FindNamedChild | Finds the first child that has the name. (Inherited from SceneNode) |
| GetChild | Get a pointer to the i:th child of this node. (Inherited from SceneNode) |
| GetChildCount | The number of direct children of this node. (Inherited from SceneNode) |
| GetClass | Get the name of the ScenePlane class. (Inherited from Object) |
| GetInf | The inferior (minimum) extent of the node. (Inherited from SceneNode) |
| GetNormal | The normal of the plane. |
| GetParent | The parent node of this node. (Inherited from SceneNode) |
| 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. (Inherited from SceneNode) |
| GetPosition | The position (translation) of the plane. |
| GetRelativeTransform | The relative transformation of this node. (Inherited from SceneNode) |
| GetScene | The scene object of the node. (Inherited from SceneNode) |
| GetSup | The superior (maximum) extent of the node. (Inherited from SceneNode) |
| HasChild | Returns true if the node has the specified child. (Inherited from SceneNode) |
| IsA | Returns true if ScenePlane is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ScenePlane object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ScenePlane object is valid. (Inherited from Object) |
| 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. Also note that the clone shares all data pointers with the original nodes, such as geometry data objects. (Inherited from SceneNode) |
| NonNull | Returns true if the ScenePlane object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ScenePlane object to the log. (Inherited from Object) |
| RemoveChild | Removes a child from the node. (Inherited from SceneNode) |
| RemoveChildren | Removes all children of this node. (Inherited from SceneNode) |
| RemoveFromParent | Removes this node from its parent. (Inherited from SceneNode) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetNormal | The normal of the plane. |
| SetPosition | The position (translation) of the plane. |
Static methods
| Method | Description |
|---|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spScenePlane, and if this is the case, returns the object cast into spScenePlane. (Inherited from Object) |
Properties details
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.
Name
The name of the ScenePlane object. (Inherited from Object)
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.
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
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 calculated, and the method returns false.
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.
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 ScenePlane class. (Inherited from Object)
GetInf
The inferior (minimum) extent of the node.
GetNormal
The normal of the plane.
GetParent
The parent node of this node.
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.
GetPosition
The position (translation) of the plane.
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 ScenePlane is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull
Returns true if the ScenePlane object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the ScenePlane object is valid. (Inherited from Object)
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. Also note that the clone shares all data pointers with the original nodes, such as geometry data objects.
NonNull
Returns true if the ScenePlane object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the ScenePlane object to the log. (Inherited from Object)
RemoveChild
Removes a child from the node.
RemoveChildren
Removes all children of this node.
RemoveFromParent
Removes this node from its parent.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
SetNormal
The normal of the plane.
SetPosition
The position (translation) of the plane.
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spScenePlane, and if this is the case, returns the object cast into spScenePlane. (Inherited from Object)