Simplygon 10.2.5200.0

Appearance

On this page

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 ​

PropertyDescription
ForcePower2TextureIf true, then force the texture sizes to be a power of 2.
NameThe name of the RecommendedTextureSizeCalculator object. (Inherited from Object)
RecommendedTextureSizeMultiplierThe texture size multiplier for the automatic texture size.

Methods ​

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
CalculateBasedOnDeviationCalculates 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()
CalculateBasedOnOnScreenSizeCalculates 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()
GetClassGet the name of the RecommendedTextureSizeCalculator class. (Inherited from Object)
GetRecommendedHeightThe recommended height calculated in CalculateRecommendedTextureSize()
GetRecommendedWidthThe recommended width calculated in CalculateRecommendedTextureSize()
IsAReturns true if RecommendedTextureSizeCalculator is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the RecommendedTextureSizeCalculator object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the RecommendedTextureSizeCalculator object is valid. (Inherited from Object)
NonNullReturns true if the RecommendedTextureSizeCalculator object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the RecommendedTextureSizeCalculator object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)

Static methods ​

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast 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 ​

cpp
// Setter
void SetForcePower2Texture( bool value ) const;

// Getter
bool GetForcePower2Texture() const;

SetForcePower2Texture parameters ​

TypeNameMinMaxDescription
boolvalueThe desired flag.

GetForcePower2Texture return value ​

Type: bool

Name ​

The name of the RecommendedTextureSizeCalculator object. (Inherited from Object)

Syntax ​

cpp
// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

SetName parameters ​

TypeNameMinMaxDescription
const char *nameNew name of the object.

GetName return value ​

Type: spString

RecommendedTextureSizeMultiplier ​

The texture size multiplier for the automatic texture size.

Syntax ​

cpp
// Setter
void SetRecommendedTextureSizeMultiplier( real value ) const;

// Getter
real GetRecommendedTextureSizeMultiplier() const;

SetRecommendedTextureSizeMultiplier parameters ​

TypeNameMinMaxDescription
realvalueThe desired multiplier.

GetRecommendedTextureSizeMultiplier return value ​

Type: real

Methods details ​

AddObserver ​

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Syntax ​

cpp
rid AddObserver( const spObserver & observer ) const;

Parameters ​

TypeNameMinMaxDescription
ObserverobserverObserver is the object that will receive events.

Return value ​

Type: rid

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 ​

cpp
void CalculateBasedOnDeviation( const spGeometryData & geom , real deviation ) const;

Parameters ​

TypeNameMinMaxDescription
GeometryDatageomThe geometry for which to calculate the recommended UV size.
realdeviationThe 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 ​

cpp
void CalculateBasedOnOnScreenSize( const spGeometryData & geom , unsigned int onScreenSize ) const;

Parameters ​

TypeNameMinMaxDescription
GeometryDatageomThe geometry for which to calculate the recommended UV size.
unsigned intonScreenSizeThe on screen size value.

GetClass ​

Get the name of the RecommendedTextureSizeCalculator class. (Inherited from Object)

Syntax ​

cpp
spString GetClass() const;

Parameters ​

GetClass takes no parameters.

Return value ​

Type: spString

GetRecommendedHeight ​

The recommended height calculated in CalculateRecommendedTextureSize()

Syntax ​

cpp
unsigned int GetRecommendedHeight() const;

Parameters ​

GetRecommendedHeight takes no parameters.

Return value ​

Type: unsigned int

GetRecommendedWidth ​

The recommended width calculated in CalculateRecommendedTextureSize()

Syntax ​

cpp
unsigned int GetRecommendedWidth() const;

Parameters ​

GetRecommendedWidth takes no parameters.

Return value ​

Type: unsigned int

IsA ​

Returns true if RecommendedTextureSizeCalculator is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax ​

cpp
bool IsA( const char * type ) const;

Parameters ​

TypeNameMinMaxDescription
const char *typeName 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 ​

cpp
bool IsNull() const;

Parameters ​

IsNull takes no parameters.

Return value ​

Type: bool

IsSameObjectAs ​

Returns true if the RecommendedTextureSizeCalculator object is valid. (Inherited from Object)

Syntax ​

cpp
bool IsSameObjectAs( const spObject & object ) const;

Parameters ​

TypeNameMinMaxDescription
ObjectobjectObject to compare with.

Return value ​

Type: bool

NonNull ​

Returns true if the RecommendedTextureSizeCalculator object is valid. (Inherited from Object)

Syntax ​

cpp
bool NonNull() const;

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 ​

cpp
void PrintInfo() const;

Parameters ​

PrintInfo takes no parameters.

RemoveObserver ​

Removes a previously added observer object. (Inherited from Object)

Syntax ​

cpp
void RemoveObserver( rid observerId ) const;

Parameters ​

TypeNameMinMaxDescription
ridobserverIdObserverId 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 ​

cpp
static bool IsClassA( const char * type ) const;

Parameters ​

TypeNameMinMaxDescription
const char *typeName 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)

Syntax ​

cpp
static spRecommendedTextureSizeCalculator SafeCast( const spObject & object ) const;

Parameters ​

TypeNameMinMaxDescription
ObjectobjectObject to cast.

Return value ​

Type: RecommendedTextureSizeCalculator