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.
Syntax
SetIsModified parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool that IsModified is to be set to. |
GetIsModified return value
Type: bool
Syntax
SetIsModified parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool that IsModified is to be set to. |
GetIsModified return value
Type: bool
Syntax
SetIsModified parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool that IsModified is to be set to. |
GetIsModified return value
Type: bool
IsVisible
The IsVisible flag. If set, the node is visible.
Syntax
SetIsVisible parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool that isVisible is to be set to. |
GetIsVisible return value
Type: bool
Syntax
SetIsVisible parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool that isVisible is to be set to. |
GetIsVisible return value
Type: bool
Syntax
SetIsVisible parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool that isVisible is to be set to. |
GetIsVisible return value
Type: bool
Name
The name of the ScenePlane object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
NodeGUID
The unique id for this node.
Syntax
SetNodeGUID parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The node id of type string. |
GetNodeGUID return value
Type: spString
Syntax
SetNodeGUID parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The node id of type string. |
GetNodeGUID return value
Type: string
Syntax
SetNodeGUID parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The node id of type string. |
GetNodeGUID return value
Type: str
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.
Syntax
SetOriginalName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | Is a string the name is to be set to. |
GetOriginalName return value
Type: spString
Syntax
SetOriginalName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | Is a string the name is to be set to. |
GetOriginalName return value
Type: string
Syntax
SetOriginalName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | Is a string the name is to be set to. |
GetOriginalName return value
Type: str
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
SceneNode | child | | | The child object. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
SceneNode | child | | | The child object. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| child | SceneNode | | | The child object. |
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
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.
Syntax
Parameters
CalculateExtents takes no parameters.
Return value
Type: bool
Syntax
Parameters
CalculateExtents takes no parameters.
Return value
Type: bool
Syntax
Parameters
CalculateExtents takes no parameters.
Return value
Type: bool
CreateChildMesh
Creates a SceneMesh node as a child node to this node.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | The GeometryData object to associate with this node. |
Return value
Type: SceneMesh
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | The GeometryData object to associate with this node. |
Return value
Type: SceneMesh
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| geom | GeometryData | | | The GeometryData object to associate with this node. |
Return value
Type: SceneMesh
CreateChildPlane
Creates a ScenePlane node as a child node to this node.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
RealData | position | | | The point on the plane. |
RealData | normal | | | The normal to the plane. |
Return value
Type: ScenePlane
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
float[] | position | | | The point on the plane. |
float[] | normal | | | The normal to the plane. |
Return value
Type: ScenePlane
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| position | float | | | The point on the plane. |
| normal | float | | | The normal to the plane. |
Return value
Type: ScenePlane
Evaluates the default global transformation of the node, regardless of node animation.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Matrix4x4 | globalTransform | | | The transformation matrix that receives the global transformation. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Matrix4x4 | globalTransform | | | The transformation matrix that receives the global transformation. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| globalTransform | Matrix4x4 | | | The transformation matrix that receives the global transformation. |
FindNamedChild
Finds the first child that has the name.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | The name of the child to look for. |
Return value
Type: SceneNode
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | The name of the child to look for. |
Return value
Type: SceneNode
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | The name of the child to look for. |
Return value
Type: SceneNode
GetChild
Get a pointer to the i:th child of this node.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | index | | | The local index of the child (0->GetChildCount()-1) |
Return value
Type: SceneNode
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | index | | | The local index of the child (0->GetChildCount()-1) |
Return value
Type: SceneNode
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| index | int | | | The local index of the child (0->GetChildCount()-1) |
Return value
Type: SceneNode
GetChildCount
The number of direct children of this node.
Syntax
Parameters
GetChildCount takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetChildCount takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetChildCount takes no parameters.
Return value
Type: int
GetClass
Get the name of the ScenePlane class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetInf
The inferior (minimum) extent of the node.
Syntax
Parameters
GetInf takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetInf takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetInf takes no parameters.
Return value
Type: list[float]
GetNormal
The normal of the plane.
Syntax
Parameters
GetNormal takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetNormal takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetNormal takes no parameters.
Return value
Type: list[float]
GetParent
The parent node of this node.
Syntax
Parameters
GetParent takes no parameters.
Return value
Type: SceneNode
Syntax
Parameters
GetParent takes no parameters.
Return value
Type: SceneNode
Syntax
Parameters
GetParent takes no parameters.
Return value
Type: 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.
Syntax
Parameters
GetPath takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetPath takes no parameters.
Return value
Type: string
Syntax
Parameters
GetPath takes no parameters.
Return value
Type: str
GetPosition
The position (translation) of the plane.
Syntax
Parameters
GetPosition takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetPosition takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetPosition takes no parameters.
Return value
Type: list[float]
The relative transformation of this node.
Syntax
Parameters
GetRelativeTransform takes no parameters.
Return value
Type: Matrix4x4
Syntax
Parameters
GetRelativeTransform takes no parameters.
Return value
Type: Matrix4x4
Syntax
Parameters
GetRelativeTransform takes no parameters.
Return value
Type: Matrix4x4
GetScene
The scene object of the node.
Syntax
Parameters
GetScene takes no parameters.
Return value
Type: Scene
Syntax
Parameters
GetScene takes no parameters.
Return value
Type: Scene
Syntax
Parameters
GetScene takes no parameters.
Return value
Type: Scene
GetSup
The superior (maximum) extent of the node.
Syntax
Parameters
GetSup takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetSup takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetSup takes no parameters.
Return value
Type: list[float]
HasChild
Returns true if the node has the specified child.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
SceneNode | child | | | The child node to look for. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
SceneNode | child | | | The child node to look for. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| child | SceneNode | | | The child node to look for. |
Return value
Type: bool
IsA
Returns true if ScenePlane is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if ScenePlane is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if ScenePlane is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if ScenePlane is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ScenePlane object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the ScenePlane object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
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.
Syntax
Parameters
NewCopy takes no parameters.
Return value
Type: SceneNode
Syntax
Parameters
NewCopy takes no parameters.
Return value
Type: SceneNode
Syntax
Parameters
NewCopy takes no parameters.
Return value
Type: SceneNode
NonNull
Returns true if the ScenePlane object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the ScenePlane object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveChild
Removes a child from the node.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
SceneNode | child | | | The child to be removed. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
SceneNode | child | | | The child to be removed. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| child | SceneNode | | | The child to be removed. |
RemoveChildren
Removes all children of this node.
Syntax
Parameters
RemoveChildren takes no parameters.
Syntax
Parameters
RemoveChildren takes no parameters.
Syntax
Parameters
RemoveChildren takes no parameters.
RemoveFromParent
Removes this node from its parent.
Syntax
Parameters
RemoveFromParent takes no parameters.
Syntax
Parameters
RemoveFromParent takes no parameters.
Syntax
Parameters
RemoveFromParent takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
SetNormal
The normal of the plane.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
RealData | vec | | | The new normal. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
float[] | vec | | | The new normal. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| vec | float | | | The new normal. |
SetPosition
The position (translation) of the plane.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
RealData | vec | | | The new position. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
float[] | vec | | | The new position. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| vec | float | | | The new position. |
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: ScenePlane
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: ScenePlane
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: ScenePlane
