class
BillboardCloudSettings
Settings for the ImpostorType: BillboardCloud
Properties
Property | Description |
FavorVerticalPlanes | Determines whether to prioritize generating vertical billboards which means they will be optimized to be viewed from the side. Otherwise, if the geometry in the input scene is mostly facing upwards/downwards then the generated billboards will also be facing upwards/downwards which makes them not well suited to being viewed from the side. |
TwoSided | Determines if the scene is intended to be viewed from both sides without back face culling. |
UseVisibilityWeights | Determines whether to prioritize accurately mapping triangles with higher visibility to billboards. |
Methods
Method | Description |
GetClass | Get the name of the BillboardCloudSettings class. |
GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. |
IsA | Returns true if BillboardCloudSettings is a or is a descendant of the class named as the type parameter. |
IsNull | Returns true if the BillboardCloudSettings 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 spBillboardCloudSettings, and if this is the case, returns the object cast into spBillboardCloudSettings. |
Properties details
FavorVerticalPlanes
Determines whether to prioritize generating vertical billboards which means they will be optimized to be viewed from the side. Otherwise, if the geometry in the input scene is mostly facing upwards/downwards then the generated billboards will also be facing upwards/downwards which makes them not well suited to being viewed from the side.
Syntax
SetFavorVerticalPlanes parameters
Type | Name | Min | Max | Description |
bool | value | | | The new value. |
GetFavorVerticalPlanes return value
Type: bool
Default: false
Syntax
SetFavorVerticalPlanes parameters
Type | Name | Min | Max | Description |
bool | value | | | The new value. |
GetFavorVerticalPlanes return value
Type: bool
Default: false
Syntax
SetFavorVerticalPlanes parameters
Name | Type | Min | Max | Description |
value | bool | | | The new value. |
GetFavorVerticalPlanes return value
Type: bool
Default: false
TwoSided
Determines if the scene is intended to be viewed from both sides without back face culling.
Syntax
SetTwoSided parameters
Type | Name | Min | Max | Description |
bool | value | | | The new value. |
GetTwoSided return value
Type: bool
Default: true
Syntax
SetTwoSided parameters
Type | Name | Min | Max | Description |
bool | value | | | The new value. |
GetTwoSided return value
Type: bool
Default: true
Syntax
SetTwoSided parameters
Name | Type | Min | Max | Description |
value | bool | | | The new value. |
GetTwoSided return value
Type: bool
Default: true
UseVisibilityWeights
Determines whether to prioritize accurately mapping triangles with higher visibility to billboards.
Syntax
SetUseVisibilityWeights parameters
Type | Name | Min | Max | Description |
bool | value | | | The new value. |
GetUseVisibilityWeights return value
Type: bool
Default: true
Syntax
SetUseVisibilityWeights parameters
Type | Name | Min | Max | Description |
bool | value | | | The new value. |
GetUseVisibilityWeights return value
Type: bool
Default: true
Syntax
SetUseVisibilityWeights parameters
Name | Type | Min | Max | Description |
value | bool | | | The new value. |
GetUseVisibilityWeights return value
Type: bool
Default: true
Methods details
GetClass
Get the name of the BillboardCloudSettings 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 BillboardCloudSettings 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 BillboardCloudSettings 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 BillboardCloudSettings 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 BillboardCloudSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the BillboardCloudSettings 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 spBillboardCloudSettings, and if this is the case, returns the object cast into spBillboardCloudSettings.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: BillboardCloudSettings
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: BillboardCloudSettings
Syntax
Parameters
Name | Type | Min | Max | Description |
object | Object | | | Object to cast. |
Return value
Type: BillboardCloudSettings