class VisibilitySettings
Visibility settings contains the parameters for how to compute the visibility of a scene and how to use it, both in the ReductionProcessor and the RemeshingProcessor. The visibility information is computed for each part of the mesh determined by the visibility from the selected SceneCamera objects. Cameras are selected using the CameraSelectionSetID. The visibility can be used to guide the reducer and/or texture coordinates generator (parameterizer) with the flags UseVisibilityWeightsInReducer respective UseVisibilityWeightsInTexcoordGenerator. There is also an option to completely throw away triangles that are deemed not visible, using the CullOccludedGeometry flag.
Properties
| Property | Description |
|---|
| CameraSelectionSetID | The ID of the selection set containing all the scene cameras and scene meshes used when computing visibility. If scene meshes are added, all their vertices will be used as omni-directional cameras. If set to -1, all cameras in the scene will be used. If both selection set name and ID are set, the name will be used. |
| CameraSelectionSetName | The name of the selection set containing all the scene cameras and scene meshes used when computing visibility. If scene meshes are added, all their vertices will be used as omni-directional cameras. If set to null, all cameras in the scene will be used. If both selection set name and ID are set, the name will be used. |
| ComputeVisibilityMode | Specifies the renderer type when computing visibility. |
| ConservativeMode | If enabled, will compute the visibility conservatively - meaning that triangles that are visible will be tagged as visible but some non-visible triangles might also be tagged as visible. If this is turned off, then it is no longer guaranteed that all visible triangles are found - but more non-visible triangles will be identified as non-visible. |
| CullOccludedGeometry | If set to true, geometry that is not visible will be removed. |
| FillNonVisibleAreaThreshold | If a group of non-visible triangles (connected to visible triangles) has an area below the FillNonVisibleAreaThreshold - it will receive the same visibility as the neighboring visible triangles. Set to zero to skip filling nonvisible regions. |
| ForceVisibilityCalculation | Set the ForceVisibilityCalculation if true, visibility weights will definitely be computed for the geometry, even if the visibility isn't specifically being used for reduction/materialLOD/culling according to the VisibilitySettings. |
| Name | The name of the VisibilitySettings object. (Inherited from Object) |
| OccluderSelectionSetID | The ID of the selection set containing all the scene meshes that should occlude the scene when calculating visibility. If set to -1, no occluders will be used. If both selection set name and ID are set, the name will be used. |
| OccluderSelectionSetName | The name of the selection set containing all the scene meshes used when computing visibility. If set to null, no occluders in the scene will be used. If both selection set name and ID are set, the name will be used. |
| RemoveTrianglesNotOccludingOtherTriangles | If enabled, will remove all the visible triangles that are not occluding any other triangle. It will also remove all non-visible triangles. |
| UseBackfaceCulling | Set whether triangles should be regarded visible when viewed from the back. |
| UseVisibilityWeightsInReducer | If set to true, visibility weights will be used in the reducer. |
| UseVisibilityWeightsInTexcoordGenerator | If set to true, visibility weights will be used when generating new texture coordinates. |
| VisibilityWeightsPower | Set how aggressively reducer should handle low visibility weights. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetBoolParameter | Get a named parameter boolean value. (Inherited from SettingsObject) |
| GetClass | Get the name of the VisibilitySettings class. (Inherited from Object) |
| GetDoubleParameter | Get a named parameter floating point value. (Inherited from SettingsObject) |
| GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject) |
| GetIntParameter | Get a named parameter integer value. (Inherited from SettingsObject) |
| GetStringParameter | Get a named parameter string value. (Inherited from SettingsObject) |
| GetUIntParameter | Get a named parameter unsigned integer value. (Inherited from SettingsObject) |
| IsA | Returns true if VisibilitySettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the VisibilitySettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the VisibilitySettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the VisibilitySettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the VisibilitySettings object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetBoolParameter | Set a named parameter boolean value. (Inherited from SettingsObject) |
| SetDoubleParameter | Set a named parameter floating point value. (Inherited from SettingsObject) |
| SetIntParameter | Set a named parameter integer value. (Inherited from SettingsObject) |
| SetStringParameter | Set a named parameter string value. (Inherited from SettingsObject) |
| SetUIntParameter | Set a named parameter unsigned integer value. (Inherited from SettingsObject) |
| SetValidateParameterNames | Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled. (Inherited from SettingsObject) |
| ToJSON | Get settings as JSON for debugging purposes. (Inherited from SettingsObject) |
| ValidateSettings | Validates the current settings values. (Inherited from SettingsObject) |
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 spVisibilitySettings, and if this is the case, returns the object cast into spVisibilitySettings. (Inherited from Object) |
Properties details
CameraSelectionSetID
The ID of the selection set containing all the scene cameras and scene meshes used when computing visibility. If scene meshes are added, all their vertices will be used as omni-directional cameras. If set to -1, all cameras in the scene will be used. If both selection set name and ID are set, the name will be used.
Syntax
SetCameraSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | | The desired SelectionSetID value. |
GetCameraSelectionSetID return value
Type: rid
Default: -1
Syntax
SetCameraSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
int | value | -1 | | The desired SelectionSetID value. |
GetCameraSelectionSetID return value
Type: int
Default: -1
Syntax
SetCameraSelectionSetID parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | -1 | | The desired SelectionSetID value. |
GetCameraSelectionSetID return value
Type: int
Default: -1
CameraSelectionSetName
The name of the selection set containing all the scene cameras and scene meshes used when computing visibility. If scene meshes are added, all their vertices will be used as omni-directional cameras. If set to null, all cameras in the scene will be used. If both selection set name and ID are set, the name will be used.
Syntax
SetCameraSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired SelectionSet name. |
GetCameraSelectionSetName return value
Type: spString
Default: nullptr
Syntax
SetCameraSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired SelectionSet name. |
GetCameraSelectionSetName return value
Type: string
Default: null
Syntax
SetCameraSelectionSetName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired SelectionSet name. |
GetCameraSelectionSetName return value
Type: str
Default: None
ComputeVisibilityMode
Specifies the renderer type when computing visibility.
Syntax
SetComputeVisibilityMode parameters
GetComputeVisibilityMode return value
Type: EComputeVisibilityMode
Default: DirectX
| Key | Value | Comment |
|---|
| DirectX | 0 | Use DirectX when computing visibility. |
| Software | 1 | Use a software renderer when computing visibility. |
Syntax
SetComputeVisibilityMode parameters
GetComputeVisibilityMode return value
Type: EComputeVisibilityMode
Default: DirectX
| Key | Value | Comment |
|---|
| DirectX | 0 | Use DirectX when computing visibility. |
| Software | 1 | Use a software renderer when computing visibility. |
Syntax
SetComputeVisibilityMode parameters
GetComputeVisibilityMode return value
Type: EComputeVisibilityMode
Default: DirectX
| Key | Value | Comment |
|---|
| EComputeVisibilityMode_DirectX | 0 | Use DirectX when computing visibility. |
| EComputeVisibilityMode_Software | 1 | Use a software renderer when computing visibility. |
ConservativeMode
If enabled, will compute the visibility conservatively - meaning that triangles that are visible will be tagged as visible but some non-visible triangles might also be tagged as visible. If this is turned off, then it is no longer guaranteed that all visible triangles are found - but more non-visible triangles will be identified as non-visible.
Syntax
SetConservativeMode parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new ConservativeMode value. |
GetConservativeMode return value
Type: bool
Default: false
Syntax
SetConservativeMode parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new ConservativeMode value. |
GetConservativeMode return value
Type: bool
Default: false
Syntax
SetConservativeMode parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The new ConservativeMode value. |
GetConservativeMode return value
Type: bool
Default: false
CullOccludedGeometry
If set to true, geometry that is not visible will be removed.
Syntax
SetCullOccludedGeometry parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new CullOccludedGeometry value. |
GetCullOccludedGeometry return value
Type: bool
Default: false
Syntax
SetCullOccludedGeometry parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new CullOccludedGeometry value. |
GetCullOccludedGeometry return value
Type: bool
Default: false
Syntax
SetCullOccludedGeometry parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The new CullOccludedGeometry value. |
GetCullOccludedGeometry return value
Type: bool
Default: false
FillNonVisibleAreaThreshold
If a group of non-visible triangles (connected to visible triangles) has an area below the FillNonVisibleAreaThreshold - it will receive the same visibility as the neighboring visible triangles. Set to zero to skip filling nonvisible regions.
Syntax
SetFillNonVisibleAreaThreshold parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0 | REAL_MAX | The new FillNonVisibleAreaThreshold value. |
GetFillNonVisibleAreaThreshold return value
Type: real
Default: 0.0
Syntax
SetFillNonVisibleAreaThreshold parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0 | REAL_MAX | The new FillNonVisibleAreaThreshold value. |
GetFillNonVisibleAreaThreshold return value
Type: float
Default: 0.0
Syntax
SetFillNonVisibleAreaThreshold parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0 | REAL_MAX | The new FillNonVisibleAreaThreshold value. |
GetFillNonVisibleAreaThreshold return value
Type: float
Default: 0.0
ForceVisibilityCalculation
Set the ForceVisibilityCalculation if true, visibility weights will definitely be computed for the geometry, even if the visibility isn't specifically being used for reduction/materialLOD/culling according to the VisibilitySettings.
Syntax
SetForceVisibilityCalculation parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new ForceVisibilityCalculation value. |
GetForceVisibilityCalculation return value
Type: bool
Default: false
Syntax
SetForceVisibilityCalculation parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new ForceVisibilityCalculation value. |
GetForceVisibilityCalculation return value
Type: bool
Default: false
Syntax
SetForceVisibilityCalculation parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The new ForceVisibilityCalculation value. |
GetForceVisibilityCalculation return value
Type: bool
Default: false
Name
The name of the VisibilitySettings 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
OccluderSelectionSetID
The ID of the selection set containing all the scene meshes that should occlude the scene when calculating visibility. If set to -1, no occluders will be used. If both selection set name and ID are set, the name will be used.
Syntax
SetOccluderSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | | The desired OccluderSelectionSetID value. |
GetOccluderSelectionSetID return value
Type: rid
Default: -1
Syntax
SetOccluderSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
int | value | -1 | | The desired OccluderSelectionSetID value. |
GetOccluderSelectionSetID return value
Type: int
Default: -1
Syntax
SetOccluderSelectionSetID parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | -1 | | The desired OccluderSelectionSetID value. |
GetOccluderSelectionSetID return value
Type: int
Default: -1
OccluderSelectionSetName
The name of the selection set containing all the scene meshes used when computing visibility. If set to null, no occluders in the scene will be used. If both selection set name and ID are set, the name will be used.
Syntax
SetOccluderSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired SelectionSet name. |
GetOccluderSelectionSetName return value
Type: spString
Default: nullptr
Syntax
SetOccluderSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired SelectionSet name. |
GetOccluderSelectionSetName return value
Type: string
Default: null
Syntax
SetOccluderSelectionSetName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired SelectionSet name. |
GetOccluderSelectionSetName return value
Type: str
Default: None
RemoveTrianglesNotOccludingOtherTriangles
If enabled, will remove all the visible triangles that are not occluding any other triangle. It will also remove all non-visible triangles.
Syntax
SetRemoveTrianglesNotOccludingOtherTriangles parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new RemoveTrianglesNotOccludingOtherTriangles value. |
GetRemoveTrianglesNotOccludingOtherTriangles return value
Type: bool
Default: false
Syntax
SetRemoveTrianglesNotOccludingOtherTriangles parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new RemoveTrianglesNotOccludingOtherTriangles value. |
GetRemoveTrianglesNotOccludingOtherTriangles return value
Type: bool
Default: false
Syntax
SetRemoveTrianglesNotOccludingOtherTriangles parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The new RemoveTrianglesNotOccludingOtherTriangles value. |
GetRemoveTrianglesNotOccludingOtherTriangles return value
Type: bool
Default: false
UseBackfaceCulling
Set whether triangles should be regarded visible when viewed from the back.
Syntax
SetUseBackfaceCulling parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetUseBackfaceCulling return value
Type: bool
Default: true
Syntax
SetUseBackfaceCulling parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetUseBackfaceCulling return value
Type: bool
Default: true
Syntax
SetUseBackfaceCulling parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetUseBackfaceCulling return value
Type: bool
Default: true
UseVisibilityWeightsInReducer
If set to true, visibility weights will be used in the reducer.
Syntax
SetUseVisibilityWeightsInReducer parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetUseVisibilityWeightsInReducer return value
Type: bool
Default: false
Syntax
SetUseVisibilityWeightsInReducer parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetUseVisibilityWeightsInReducer return value
Type: bool
Default: false
Syntax
SetUseVisibilityWeightsInReducer parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetUseVisibilityWeightsInReducer return value
Type: bool
Default: false
UseVisibilityWeightsInTexcoordGenerator
If set to true, visibility weights will be used when generating new texture coordinates.
Syntax
SetUseVisibilityWeightsInTexcoordGenerator parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new UseVisibilityWeightsInTexcoordGenerator value. |
GetUseVisibilityWeightsInTexcoordGenerator return value
Type: bool
Default: false
Syntax
SetUseVisibilityWeightsInTexcoordGenerator parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new UseVisibilityWeightsInTexcoordGenerator value. |
GetUseVisibilityWeightsInTexcoordGenerator return value
Type: bool
Default: false
Syntax
SetUseVisibilityWeightsInTexcoordGenerator parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The new UseVisibilityWeightsInTexcoordGenerator value. |
GetUseVisibilityWeightsInTexcoordGenerator return value
Type: bool
Default: false
VisibilityWeightsPower
Set how aggressively reducer should handle low visibility weights.
Syntax
SetVisibilityWeightsPower parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0 | REAL_MAX | Power of influence (default 1.0). |
GetVisibilityWeightsPower return value
Type: real
Default: 1.0
Syntax
SetVisibilityWeightsPower parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0 | REAL_MAX | Power of influence (default 1.0). |
GetVisibilityWeightsPower return value
Type: float
Default: 1.0
Syntax
SetVisibilityWeightsPower parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0 | REAL_MAX | Power of influence (default 1.0). |
GetVisibilityWeightsPower return value
Type: float
Default: 1.0
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
GetBoolParameter
Get a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: bool
GetClass
Get the name of the VisibilitySettings 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
GetDoubleParameter
Get a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: float
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
GetIntParameter
Get a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
GetStringParameter
Get a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: str
GetUIntParameter
Get a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: unsigned int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: uint
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
IsA
Returns true if VisibilitySettings 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 VisibilitySettings 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 VisibilitySettings 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 VisibilitySettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the VisibilitySettings 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 VisibilitySettings 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 VisibilitySettings 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 VisibilitySettings 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. |
SetBoolParameter
Set a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | bool | | | New value for parameter. |
Return value
Type: bool
SetDoubleParameter
Set a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | float | | | New value for parameter. |
Return value
Type: bool
SetIntParameter
Set a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetStringParameter
Set a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
const char * | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
string | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | str | | | New value for parameter. |
Return value
Type: bool
SetUIntParameter
Set a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
unsigned int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
uint | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetValidateParameterNames
Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| validate | bool | | | Flag indicating if validation is performed or not. |
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
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. (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 spVisibilitySettings, and if this is the case, returns the object cast into spVisibilitySettings. (Inherited from Object)
