class
OcclusionMeshProcessor
The occlusion mesh processor creates a reconstruction of the input mesh from its silhouette. This means concavities and internal geometry disappear. WARNING: Experimental. Generates nice meshes, but currently very slow at high settings. Recommended onscreensize ~100
Properties
Property | Description |
Name | The name of the OcclusionMeshProcessor object. (Inherited from Object) |
Scene | The scene used for processing. All mesh nodes in the whole scene tree will be replaced by one proxy mesh. Please note that internal references might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor. |
Methods
Method | Description |
AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
Clear | Clear all internal states of the object. This will NOT clear the parameters set in the object. (Inherited from ProcessingObject) |
GetClass | Get the name of the OcclusionMeshProcessor class. (Inherited from Object) |
GetOcclusionMeshSettings | The settings for the OcclusionMeshProcessor. |
GetPercentDone | Returns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject) |
IsA | Returns true if OcclusionMeshProcessor is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
IsNull | Returns true if the OcclusionMeshProcessor object is invalid. (Inherited from Object) |
IsSameObjectAs | Returns true if the OcclusionMeshProcessor object is valid. (Inherited from Object) |
NonNull | Returns true if the OcclusionMeshProcessor object is valid. (Inherited from Object) |
PrintInfo | Prints the content/info of the OcclusionMeshProcessor object to the log. (Inherited from Object) |
RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
RunProcessing | Runs the processing the object is designed for. (Inherited from ProcessingObject) |
ToJSON | Get settings as JSON for debugging purposes. (Inherited from ProcessingObject) |
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 spOcclusionMeshProcessor, and if this is the case, returns the object cast into spOcclusionMeshProcessor. (Inherited from Object) |
Properties details
Name
The name of the OcclusionMeshProcessor 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
Scene
The scene used for processing. All mesh nodes in the whole scene tree will be replaced by one proxy mesh. Please note that internal references might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.
Syntax
SetScene parameters
Type | Name | Min | Max | Description |
Scene | value | | | The scene node to which SceneRoot will be set. |
GetScene return value
Type: Scene
Syntax
SetScene parameters
Type | Name | Min | Max | Description |
Scene | value | | | The scene node to which SceneRoot will be set. |
GetScene return value
Type: Scene
Syntax
SetScene parameters
Name | Type | Min | Max | Description |
value | Scene | | | The scene node to which SceneRoot will be set. |
GetScene return value
Type: Scene
Methods details
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
Clear
Clear all internal states of the object. This will NOT clear the parameters set in the object.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
GetClass
Get the name of the OcclusionMeshProcessor 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
GetOcclusionMeshSettings
The settings for the OcclusionMeshProcessor.
GetPercentDone
Returns the current progress of the processing as a value between 0 and 100.
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: real
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: float
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: float
IsA
Returns true if OcclusionMeshProcessor 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 OcclusionMeshProcessor 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 OcclusionMeshProcessor 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 OcclusionMeshProcessor is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the OcclusionMeshProcessor 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 OcclusionMeshProcessor 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
NonNull
Returns true if the OcclusionMeshProcessor 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 OcclusionMeshProcessor 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.
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. |
RunProcessing
Runs the processing the object is designed for.
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
Key | Value | Comment |
Finished | 0 | The process finished with no error |
Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
Key | Value | Comment |
Finished | 0 | The process finished with no error |
Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
Key | Value | Comment |
EProcessStatus_Finished | 0 | The process finished with no error |
EProcessStatus_Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
ToJSON
Get settings as JSON for debugging purposes.
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: spString
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: string
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: str
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 spOcclusionMeshProcessor, and if this is the case, returns the object cast into spOcclusionMeshProcessor. (Inherited from Object)