class
GeometryCullingSettings
Settings for volumetric triangle culling functionality. These settings control the clipping planes and geometries that are used for triangle culling the output of Simplygon scene processors.
Properties
Property | Description |
ClippingGeometrySelectionSetID | Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set. |
ClippingGeometrySelectionSetName | Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set. |
ClippingPlaneSelectionSetID | Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set. |
ClippingPlaneSelectionSetName | Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set. |
UseClippingGeometry | If set, the geometries defined in the matching selection set will be used to clip the process geometry. What side of the geometry that will be culled is determined by the triangle facing, so make sure your winding is correct and that triangles point "up" toward the space you want to keep. Inconsistent triangle winding or meshes that do not have a clear local inside and outside will cause inconsistent results when used as clipping geometries. |
UseClippingPlanes | If true the ScenePlanes in the input scene (or the planes selected by the selection set settings) will be used to clip the mesh. |
Methods
Method | Description |
GetClass | Get the name of the GeometryCullingSettings class. |
GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. |
IsA | Returns true if GeometryCullingSettings is a or is a descendant of the class named as the type parameter. |
IsNull | Returns true if the GeometryCullingSettings object is invalid. |
ValidateSettings | Validates the current settings values. |
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 spGeometryCullingSettings, and if this is the case, returns the object cast into spGeometryCullingSettings. |
Properties details
ClippingGeometrySelectionSetID
Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set.
Syntax
SetClippingGeometrySelectionSetID parameters
Type | Name | Min | Max | Description |
rid | value | -1 | | The desired SelectionSet id. |
GetClippingGeometrySelectionSetID return value
Type: rid
Default: -1
Syntax
SetClippingGeometrySelectionSetID parameters
Type | Name | Min | Max | Description |
rid | value | -1 | | The desired SelectionSet id. |
GetClippingGeometrySelectionSetID return value
Type: rid
Default: -1
Syntax
SetClippingGeometrySelectionSetID parameters
Name | Type | Min | Max | Description |
value | int | -1 | | The desired SelectionSet id. |
GetClippingGeometrySelectionSetID return value
Type: int
Default: -1
ClippingGeometrySelectionSetName
Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set.
Syntax
SetClippingGeometrySelectionSetName parameters
Type | Name | Min | Max | Description |
const char * | value | | | The desired SelectionSet name. |
GetClippingGeometrySelectionSetName return value
Type: spString
Default: nullptr
Syntax
SetClippingGeometrySelectionSetName parameters
Type | Name | Min | Max | Description |
string | value | | | The desired SelectionSet name. |
GetClippingGeometrySelectionSetName return value
Type: string
Default: null
Syntax
SetClippingGeometrySelectionSetName parameters
Name | Type | Min | Max | Description |
value | str | | | The desired SelectionSet name. |
GetClippingGeometrySelectionSetName return value
Type: str
Default: None
ClippingPlaneSelectionSetID
Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set.
Syntax
SetClippingPlaneSelectionSetID parameters
Type | Name | Min | Max | Description |
rid | value | -1 | | The desired SelectionSet id. |
GetClippingPlaneSelectionSetID return value
Type: rid
Default: -1
Syntax
SetClippingPlaneSelectionSetID parameters
Type | Name | Min | Max | Description |
rid | value | -1 | | The desired SelectionSet id. |
GetClippingPlaneSelectionSetID return value
Type: rid
Default: -1
Syntax
SetClippingPlaneSelectionSetID parameters
Name | Type | Min | Max | Description |
value | int | -1 | | The desired SelectionSet id. |
GetClippingPlaneSelectionSetID return value
Type: int
Default: -1
ClippingPlaneSelectionSetName
Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set.
Syntax
SetClippingPlaneSelectionSetName parameters
Type | Name | Min | Max | Description |
const char * | value | | | The desired SelectionSet name. |
GetClippingPlaneSelectionSetName return value
Type: spString
Default: nullptr
Syntax
SetClippingPlaneSelectionSetName parameters
Type | Name | Min | Max | Description |
string | value | | | The desired SelectionSet name. |
GetClippingPlaneSelectionSetName return value
Type: string
Default: null
Syntax
SetClippingPlaneSelectionSetName parameters
Name | Type | Min | Max | Description |
value | str | | | The desired SelectionSet name. |
GetClippingPlaneSelectionSetName return value
Type: str
Default: None
UseClippingGeometry
If set, the geometries defined in the matching selection set will be used to clip the process geometry. What side of the geometry that will be culled is determined by the triangle facing, so make sure your winding is correct and that triangles point "up" toward the space you want to keep. Inconsistent triangle winding or meshes that do not have a clear local inside and outside will cause inconsistent results when used as clipping geometries.
Syntax
SetUseClippingGeometry parameters
Type | Name | Min | Max | Description |
bool | value | | | The bool UseClippingGeometry will be set to. |
GetUseClippingGeometry return value
Type: bool
Default: false
Syntax
SetUseClippingGeometry parameters
Type | Name | Min | Max | Description |
bool | value | | | The bool UseClippingGeometry will be set to. |
GetUseClippingGeometry return value
Type: bool
Default: false
Syntax
SetUseClippingGeometry parameters
Name | Type | Min | Max | Description |
value | bool | | | The bool UseClippingGeometry will be set to. |
GetUseClippingGeometry return value
Type: bool
Default: false
UseClippingPlanes
If true the ScenePlanes in the input scene (or the planes selected by the selection set settings) will be used to clip the mesh.
Syntax
SetUseClippingPlanes parameters
Type | Name | Min | Max | Description |
bool | value | | | The bool UseClippingPlanes will be set to. |
GetUseClippingPlanes return value
Type: bool
Default: false
Syntax
SetUseClippingPlanes parameters
Type | Name | Min | Max | Description |
bool | value | | | The bool UseClippingPlanes will be set to. |
GetUseClippingPlanes return value
Type: bool
Default: false
Syntax
SetUseClippingPlanes parameters
Name | Type | Min | Max | Description |
value | bool | | | The bool UseClippingPlanes will be set to. |
GetUseClippingPlanes return value
Type: bool
Default: false
Methods details
GetClass
Get the name of the GeometryCullingSettings class.
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
GetErrorString
Returns a string describing the error that was found the last time ValidateSettings was performed.
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: string
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: str
IsA
Returns true if GeometryCullingSettings is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | type | | | Name of the class to check if GeometryCullingSettings 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 GeometryCullingSettings 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 GeometryCullingSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the GeometryCullingSettings object is invalid.
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
ValidateSettings
Validates the current settings values.
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter.
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 spGeometryCullingSettings, and if this is the case, returns the object cast into spGeometryCullingSettings.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: GeometryCullingSettings
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: GeometryCullingSettings
Syntax
Parameters
Name | Type | Min | Max | Description |
object | Object | | | Object to cast. |
Return value
Type: GeometryCullingSettings