Simplygon 10 Documentation

# 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

// Setter
void SetForcePower2Texture( bool value ) const;

// Getter
bool GetForcePower2Texture() const;

# SetForcePower2Texture parameters

Type Name Min Max Description
bool value The desired flag.

# GetForcePower2Texture return value

Type: bool

# Name

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

# Syntax

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

// Getter
spString GetName() const;

# SetName parameters

Type Name Min Max Description
const char * name New name of the object.

# GetName return value

Type: spString

# RecommendedTextureSizeMultiplier

The texture size multiplier for the automatic texture size.

# Syntax

// Setter
void SetRecommendedTextureSizeMultiplier( real value ) const;

// Getter
real GetRecommendedTextureSizeMultiplier() const;

# SetRecommendedTextureSizeMultiplier parameters

Type Name Min Max Description
real value The 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

rid AddObserver( const spObserver & observer ) const;

# Parameters

Type Name Min Max Description
Observer observer Observer 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

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

# Parameters

Type Name Min Max Description
GeometryData geom The geometry for which to calculate the recommended UV size.
real deviation 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

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

# 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.

# GetClass

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

# Syntax

spString GetClass() const;

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetRecommendedHeight

The recommended height calculated in CalculateRecommendedTextureSize()

# Syntax

unsigned int GetRecommendedHeight() const;

# Parameters

GetRecommendedHeight takes no parameters.

# Return value

Type: unsigned int

# GetRecommendedWidth

The recommended width calculated in CalculateRecommendedTextureSize()

# Syntax

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

bool IsA( const char * type ) const;

# 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

# IsNull

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

# Syntax

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

bool IsSameObjectAs( const spObject & object ) const;

# Parameters

Type Name 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

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

void PrintInfo() const;

# Parameters

PrintInfo takes no parameters.

# RemoveObserver

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

# Syntax

void RemoveObserver( rid observerId ) const;

# Parameters

Type Name Min Max Description
rid observerId 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

static bool IsClassA( const char * type ) const;

# 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

# 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

static spRecommendedTextureSizeCalculator SafeCast( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: RecommendedTextureSizeCalculator

← SceneValidator →