class RecommendedTextureSizeCalculator
Estimates a coarse recommended UV size (width and height) for a geometry based on only its surface area and either the distance it is allowed to deviate or its intended on screen size. The UVs are assumed to be unique i.e. not tiled/repeated. RecommendedWidth and RecommendedHeight will only differ from each other if ForcePower2Texture is enabled.
Properties
| Property | Description |
|---|
| ForcePower2Texture | If true, then force the texture sizes to be a power of 2. |
| Name | The name of the RecommendedTextureSizeCalculator object. (Inherited from Object) |
| RecommendedTextureSizeMultiplier | The texture size multiplier for the automatic texture size. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| CalculateBasedOnDeviation | Calculates the recommended UV size based on the surface area of the geometry and the allowed deviation. The recommended width and height can be fetched with the GetRecommendedWidth() and GetRecommendedHeight() |
| CalculateBasedOnOnScreenSize | Calculates the recommended UV size based on the surface area of the geometry and the intended on screen size (in pixels) The recommended width and height can be fetched with the GetRecommendedWidth() and GetRecommendedHeight() |
| GetClass | Get the name of the RecommendedTextureSizeCalculator class. (Inherited from Object) |
| GetRecommendedHeight | The recommended height calculated in CalculateRecommendedTextureSize() |
| GetRecommendedWidth | The recommended width calculated in CalculateRecommendedTextureSize() |
| IsA | Returns true if RecommendedTextureSizeCalculator is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the RecommendedTextureSizeCalculator object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the RecommendedTextureSizeCalculator object is valid. (Inherited from Object) |
| NonNull | Returns true if the RecommendedTextureSizeCalculator object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the RecommendedTextureSizeCalculator object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
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 spRecommendedTextureSizeCalculator, and if this is the case, returns the object cast into spRecommendedTextureSizeCalculator. (Inherited from Object) |
Properties details
ForcePower2Texture
If true, then force the texture sizes to be a power of 2.
Syntax
SetForcePower2Texture parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag. |
GetForcePower2Texture return value
Type: bool
Syntax
SetForcePower2Texture parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag. |
GetForcePower2Texture return value
Type: bool
Syntax
SetForcePower2Texture parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag. |
GetForcePower2Texture return value
Type: bool
Name
The name of the RecommendedTextureSizeCalculator 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
RecommendedTextureSizeMultiplier
The texture size multiplier for the automatic texture size.
Syntax
SetRecommendedTextureSizeMultiplier parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | The desired multiplier. |
GetRecommendedTextureSizeMultiplier return value
Type: real
Syntax
SetRecommendedTextureSizeMultiplier parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | The desired multiplier. |
GetRecommendedTextureSizeMultiplier return value
Type: float
Syntax
SetRecommendedTextureSizeMultiplier parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | The desired multiplier. |
GetRecommendedTextureSizeMultiplier return value
Type: float
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
CalculateBasedOnDeviation
Calculates the recommended UV size based on the surface area of the geometry and the allowed deviation. The recommended width and height can be fetched with the GetRecommendedWidth() and GetRecommendedHeight()
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | The geometry for which to calculate the recommended UV size. |
real | deviation | | | The deviation value. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | The geometry for which to calculate the recommended UV size. |
float | deviation | | | The deviation value. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| geom | GeometryData | | | The geometry for which to calculate the recommended UV size. |
| deviation | float | | | The deviation value. |
CalculateBasedOnOnScreenSize
Calculates the recommended UV size based on the surface area of the geometry and the intended on screen size (in pixels) The recommended width and height can be fetched with the GetRecommendedWidth() and GetRecommendedHeight()
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | The geometry for which to calculate the recommended UV size. |
unsigned int | onScreenSize | | | The on screen size value. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | The geometry for which to calculate the recommended UV size. |
uint | onScreenSize | | | The on screen size value. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| geom | GeometryData | | | The geometry for which to calculate the recommended UV size. |
| onScreenSize | int | | | The on screen size value. |
GetClass
Get the name of the RecommendedTextureSizeCalculator 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
GetRecommendedHeight
The recommended height calculated in CalculateRecommendedTextureSize()
Syntax
Parameters
GetRecommendedHeight takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetRecommendedHeight takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetRecommendedHeight takes no parameters.
Return value
Type: int
GetRecommendedWidth
The recommended width calculated in CalculateRecommendedTextureSize()
Syntax
Parameters
GetRecommendedWidth takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetRecommendedWidth takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetRecommendedWidth takes no parameters.
Return value
Type: int
IsA
Returns true if RecommendedTextureSizeCalculator 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 RecommendedTextureSizeCalculator 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 RecommendedTextureSizeCalculator 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 RecommendedTextureSizeCalculator is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the RecommendedTextureSizeCalculator 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 RecommendedTextureSizeCalculator 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 RecommendedTextureSizeCalculator 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 RecommendedTextureSizeCalculator 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. |
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 spRecommendedTextureSizeCalculator, and if this is the case, returns the object cast into spRecommendedTextureSizeCalculator. (Inherited from Object)
