class ChartAggregator

Computes new texture coordinates for a geometry with overlapping UV charts.

Properties

Property	Description
AutomaticTextureSizeMultiplier	A texture dimension length multiplier for the automatic texture size.
ChartAggregatorMode	Determines which method to use when aggregating the UVs. TextureSizeProportions: Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps. SurfaceArea: Aggregated UV charts will have their size set based on its actual geometrical size. OriginalPixelDensity: The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size. UVSizeProportions: Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in.
ExpandZeroAreaUVs	If ExpandZeroAreaUVs is enabled then triangles that have zero area will be slightly expanded.
ForcePower2Texture	If UseAutomaticTextureSize is enabled, then force the texture sizes to be a power of 2.
GutterSpace	The minimum number of pixels between charts.
InputMaterialCount	The number of input materials used in the original geometry for mapping to multiple output materials. This needs to be set before you can set any specific in-out material mapping. 0 signifies that no in-out material mapping is used, ie. the process will produce one resulting mapping image.
LockUVRotation	If LockUVRotation is enabled, only the original UV rotation will be used. Otherwise 4 rotations are used (90 degree rotations).
Name	The name of the ChartAggregator object. (Inherited from Object)
OriginalChartProportionsChannel	Set OriginalChartProportionsChannel to an SG_MATERIAL_CHANNEL_[...]. This channel determines which texture channel to look at when determining which chart sizes to keep.
OutputMaterialCount	The number of output mapping images that are to be generated. The triangle field OutputMaterialIds also needs to be set, or the material IDs of the original geometry needs to be set to a specific output material in this setting object.
SurfaceAreaScale	If multiple UV charts overlap and have the same material, SurfaceAreaScale specifies which of those instances determines the the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.
TexCoordLevel	Which TexCoord level to get charts from during re-parameterization. If a TexCoordName is set, it will override the TexCoordLevel.
TexCoordName	Which TexCoord name to get charts from during re-parameterization.
TextureHeight	The height of the texture to use.
TextureWidth	The width of the texture to use.
UseAutomaticTextureSize	The automatic_texture_size flag. If true, then texture sizes will be computed for the reduced mesh depending on its pixel size on screen.
UseVertexWeights	The UseVertexWeights flag to scale the charts according to their vertex weights.

Methods

Method	Description
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClass	Get the name of the ChartAggregator class. (Inherited from Object)
GetGutterSpaceForMaterialIndex	The minimum number of pixels between charts.
GetInputOutputMaterialMapping	The previously set material mapping for matId.
GetKeepOriginalChartSizesTextureHeight	If KeepOriginalChartSizes is enabled: calling GetKeepOriginalChartSizesTextureWidth and GetKeepOriginalChartSizesTextureHeight after parameterization will return the final texture sizes.
GetKeepOriginalChartSizesTextureHeightForMaterialIndex	If KeepOriginalChartSizes is enabled: calling GetKeepOriginalChartSizesTextureWidth and GetKeepOriginalChartSizesTextureHeight after parameterization will return the final texture sizes.
GetKeepOriginalChartSizesTextureWidth	If KeepOriginalChartSizes is enabled: calling GetKeepOriginalChartSizesTextureWidth and GetKeepOriginalChartSizesTextureHeight after parameterization will return the final texture sizes.
GetKeepOriginalChartSizesTextureWidthForMaterialIndex	If KeepOriginalChartSizes is enabled: calling GetKeepOriginalChartSizesTextureWidth and GetKeepOriginalChartSizesTextureHeight after parameterization will return the final texture sizes.
GetTextureHeightForMaterialIndex	The height of the texture to use.
GetTextureWidthForMaterialIndex	The width of the texture to use.
IsA	Returns true if ChartAggregator is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the ChartAggregator object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the ChartAggregator object is valid. (Inherited from Object)
NonNull	Returns true if the ChartAggregator object is valid. (Inherited from Object)
Parameterize	Executes the parameterization of the geometry.
PrintInfo	Prints the content/info of the ChartAggregator object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
SetGutterSpaceForMaterialIndex	The minimum number of pixels between charts.
SetInputOutputMaterialMapping	The material mapping for inMaterialId, meaning what material of the generated LOD inMaterialId will be baked into. Both InputMaterialCount and OutputMaterialCount need to be set for this mapping to work, and all original materials need to be mapped to an existing output id.
SetMaterialTable	The scene material table.
SetSeparateOverlappingCharts	The Separate Overlapping Charts flag. If charts are overlapping in the original texture coords, they will be separated.
SetTextureHeightForMaterialIndex	The height of the texture to use.
SetTextureTable	The scene texture table.
SetTextureWidthForMaterialIndex	The width of the texture to use.

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 spChartAggregator, and if this is the case, returns the object cast into spChartAggregator. (Inherited from Object)

Properties details

AutomaticTextureSizeMultiplier

A texture dimension length multiplier for the automatic texture size.

Syntax

// Setter
void SetAutomaticTextureSizeMultiplier( real value ) const;

// Getter
real GetAutomaticTextureSizeMultiplier() const;

SetAutomaticTextureSizeMultiplier parameters

Type	Name	Min	Max	Description
real	value			The desired multiplier.

GetAutomaticTextureSizeMultiplier return value

Type: real

Syntax

// Setter
void SetAutomaticTextureSizeMultiplier(float value);

// Getter
float GetAutomaticTextureSizeMultiplier();

SetAutomaticTextureSizeMultiplier parameters

Type	Name	Min	Max	Description
float	value			The desired multiplier.

GetAutomaticTextureSizeMultiplier return value

Type: float

Syntax

# Setter
None SetAutomaticTextureSizeMultiplier(value: float)

# Getter
float GetAutomaticTextureSizeMultiplier()

SetAutomaticTextureSizeMultiplier parameters

Name	Type	Min	Max	Description
value	float			The desired multiplier.

GetAutomaticTextureSizeMultiplier return value

Type: float

ChartAggregatorMode

Determines which method to use when aggregating the UVs. TextureSizeProportions: Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps. SurfaceArea: Aggregated UV charts will have their size set based on its actual geometrical size. OriginalPixelDensity: The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size. UVSizeProportions: Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in.

Syntax

// Setter
void SetChartAggregatorMode( Simplygon::EChartAggregatorMode value ) const;

// Getter
Simplygon::EChartAggregatorMode GetChartAggregatorMode() const;

SetChartAggregatorMode parameters

Type	Name	Min	Max	Description
EChartAggregatorMode	value			The ChartAggregatorMode value to use.

GetChartAggregatorMode return value

Type: EChartAggregatorMode

Default: TextureSizeProportions

Key	Value	Comment
TextureSizeProportions	0	Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps.
SurfaceArea	1	Aggregated UV charts will have their size set based on its actual geometrical size.
OriginalPixelDensity	2	The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size.
UVSizeProportions	3	Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in.

Syntax

// Setter
void SetChartAggregatorMode(EChartAggregatorMode value);

// Getter
EChartAggregatorMode GetChartAggregatorMode();

SetChartAggregatorMode parameters

Type	Name	Min	Max	Description
EChartAggregatorMode	value			The ChartAggregatorMode value to use.

GetChartAggregatorMode return value

Type: EChartAggregatorMode

Default: TextureSizeProportions

Key	Value	Comment
TextureSizeProportions	0	Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps.
SurfaceArea	1	Aggregated UV charts will have their size set based on its actual geometrical size.
OriginalPixelDensity	2	The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size.
UVSizeProportions	3	Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in.

Syntax

# Setter
None SetChartAggregatorMode(value: EChartAggregatorMode_*)

# Getter
EChartAggregatorMode_* GetChartAggregatorMode()

SetChartAggregatorMode parameters

Name	Type	Min	Max	Description
value	EChartAggregatorMode			The ChartAggregatorMode value to use.

GetChartAggregatorMode return value

Type: EChartAggregatorMode

Default: TextureSizeProportions

Key	Value	Comment
EChartAggregatorMode_TextureSizeProportions	0	Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps.
EChartAggregatorMode_SurfaceArea	1	Aggregated UV charts will have their size set based on its actual geometrical size.
EChartAggregatorMode_OriginalPixelDensity	2	The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size.
EChartAggregatorMode_UVSizeProportions	3	Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in.

ExpandZeroAreaUVs

If ExpandZeroAreaUVs is enabled then triangles that have zero area will be slightly expanded.

Syntax

// Setter
void SetExpandZeroAreaUVs( bool value ) const;

// Getter
bool GetExpandZeroAreaUVs() const;

SetExpandZeroAreaUVs parameters

Type	Name	Min	Max	Description
bool	value			The new ExpandZeroAreaUVs.

GetExpandZeroAreaUVs return value

Type: bool

Syntax

// Setter
void SetExpandZeroAreaUVs(bool value);

// Getter
bool GetExpandZeroAreaUVs();

SetExpandZeroAreaUVs parameters

Type	Name	Min	Max	Description
bool	value			The new ExpandZeroAreaUVs.

GetExpandZeroAreaUVs return value

Type: bool

Syntax

# Setter
None SetExpandZeroAreaUVs(value: bool)

# Getter
bool GetExpandZeroAreaUVs()

SetExpandZeroAreaUVs parameters

Name	Type	Min	Max	Description
value	bool			The new ExpandZeroAreaUVs.

GetExpandZeroAreaUVs return value

Type: bool

ForcePower2Texture

If UseAutomaticTextureSize is enabled, 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

Syntax

// Setter
void SetForcePower2Texture(bool value);

// Getter
bool GetForcePower2Texture();

SetForcePower2Texture parameters

Type	Name	Min	Max	Description
bool	value			The desired flag.

GetForcePower2Texture return value

Type: bool

Syntax

# Setter
None SetForcePower2Texture(value: bool)

# Getter
bool GetForcePower2Texture()

SetForcePower2Texture parameters

Name	Type	Min	Max	Description
value	bool			The desired flag.

GetForcePower2Texture return value

Type: bool

GutterSpace

The minimum number of pixels between charts.

Syntax

// Setter
void SetGutterSpace( unsigned int value ) const;

// Getter
unsigned int GetGutterSpace() const;

SetGutterSpace parameters

Type	Name	Min	Max	Description
unsigned int	value			The value to which GutterSpace will be set.

GetGutterSpace return value

Type: unsigned int

Syntax

// Setter
void SetGutterSpace(uint value);

// Getter
uint GetGutterSpace();

SetGutterSpace parameters

Type	Name	Min	Max	Description
uint	value			The value to which GutterSpace will be set.

GetGutterSpace return value

Type: uint

Syntax

# Setter
None SetGutterSpace(value: int)

# Getter
int GetGutterSpace()

SetGutterSpace parameters

Name	Type	Min	Max	Description
value	int			The value to which GutterSpace will be set.

GetGutterSpace return value

Type: int

InputMaterialCount

The number of input materials used in the original geometry for mapping to multiple output materials. This needs to be set before you can set any specific in-out material mapping. 0 signifies that no in-out material mapping is used, ie. the process will produce one resulting mapping image.

Syntax

// Setter
void SetInputMaterialCount( unsigned int value ) const;

// Getter
unsigned int GetInputMaterialCount() const;

SetInputMaterialCount parameters

Type	Name	Min	Max	Description
unsigned int	value			The number of outputs.

GetInputMaterialCount return value

Type: unsigned int

Syntax

// Setter
void SetInputMaterialCount(uint value);

// Getter
uint GetInputMaterialCount();

SetInputMaterialCount parameters

Type	Name	Min	Max	Description
uint	value			The number of outputs.

GetInputMaterialCount return value

Type: uint

Syntax

# Setter
None SetInputMaterialCount(value: int)

# Getter
int GetInputMaterialCount()

SetInputMaterialCount parameters

Name	Type	Min	Max	Description
value	int			The number of outputs.

GetInputMaterialCount return value

Type: int

LockUVRotation

If LockUVRotation is enabled, only the original UV rotation will be used. Otherwise 4 rotations are used (90 degree rotations).

Syntax

// Setter
void SetLockUVRotation( bool value ) const;

// Getter
bool GetLockUVRotation() const;

SetLockUVRotation parameters

Type	Name	Min	Max	Description
bool	value			The new LockUVRotation.

GetLockUVRotation return value

Type: bool

Syntax

// Setter
void SetLockUVRotation(bool value);

// Getter
bool GetLockUVRotation();

SetLockUVRotation parameters

Type	Name	Min	Max	Description
bool	value			The new LockUVRotation.

GetLockUVRotation return value

Type: bool

Syntax

# Setter
None SetLockUVRotation(value: bool)

# Getter
bool GetLockUVRotation()

SetLockUVRotation parameters

Name	Type	Min	Max	Description
value	bool			The new LockUVRotation.

GetLockUVRotation return value

Type: bool

Name

The name of the ChartAggregator 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

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

Type	Name	Min	Max	Description
string	name			New name of the object.

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

Name	Type	Min	Max	Description
name	str			New name of the object.

GetName return value

Type: str

OriginalChartProportionsChannel

Set OriginalChartProportionsChannel to an SG_MATERIAL_CHANNEL_[...]. This channel determines which texture channel to look at when determining which chart sizes to keep.

Syntax

// Setter
void SetOriginalChartProportionsChannel( const char * value ) const;

// Getter
spString GetOriginalChartProportionsChannel() const;

SetOriginalChartProportionsChannel parameters

Type	Name	Min	Max	Description
const char *	value			The new OriginalChartProportionsChannel value.

GetOriginalChartProportionsChannel return value

Type: spString

Syntax

// Setter
void SetOriginalChartProportionsChannel(string value);

// Getter
string GetOriginalChartProportionsChannel();

SetOriginalChartProportionsChannel parameters

Type	Name	Min	Max	Description
string	value			The new OriginalChartProportionsChannel value.

GetOriginalChartProportionsChannel return value

Type: string

Syntax

# Setter
None SetOriginalChartProportionsChannel(value: str)

# Getter
str GetOriginalChartProportionsChannel()

SetOriginalChartProportionsChannel parameters

Name	Type	Min	Max	Description
value	str			The new OriginalChartProportionsChannel value.

GetOriginalChartProportionsChannel return value

Type: str

OutputMaterialCount

The number of output mapping images that are to be generated. The triangle field OutputMaterialIds also needs to be set, or the material IDs of the original geometry needs to be set to a specific output material in this setting object.

Syntax

// Setter
void SetOutputMaterialCount( unsigned int value ) const;

// Getter
unsigned int GetOutputMaterialCount() const;

SetOutputMaterialCount parameters

Type	Name	Min	Max	Description
unsigned int	value	1	SG_MAXIMUM_CHART_AGGREGATOR_OUTPUT_MATERIAL_COUNT	The number of outputs.

GetOutputMaterialCount return value

Type: unsigned int

Syntax

// Setter
void SetOutputMaterialCount(uint value);

// Getter
uint GetOutputMaterialCount();

SetOutputMaterialCount parameters

Type	Name	Min	Max	Description
uint	value	1	SG_MAXIMUM_CHART_AGGREGATOR_OUTPUT_MATERIAL_COUNT	The number of outputs.

GetOutputMaterialCount return value

Type: uint

Syntax

# Setter
None SetOutputMaterialCount(value: int)

# Getter
int GetOutputMaterialCount()

SetOutputMaterialCount parameters

Name	Type	Min	Max	Description
value	int	1	SG_MAXIMUM_CHART_AGGREGATOR_OUTPUT_MATERIAL_COUNT	The number of outputs.

GetOutputMaterialCount return value

Type: int

SurfaceAreaScale

If multiple UV charts overlap and have the same material, SurfaceAreaScale specifies which of those instances determines the the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.

Syntax

// Setter
void SetSurfaceAreaScale( Simplygon::ESurfaceAreaScale value ) const;

// Getter
Simplygon::ESurfaceAreaScale GetSurfaceAreaScale() const;

SetSurfaceAreaScale parameters

Type	Name	Min	Max	Description
ESurfaceAreaScale	value			The SurfaceAreaScale value to use.

GetSurfaceAreaScale return value

Type: ESurfaceAreaScale

Default: LargestInstance

Key	Value	Comment
LargestInstance	0	If multiple UV charts overlap and have the same material, the largest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.
SmallestInstance	1	If multiple UV charts overlap and have the same material, the smallest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.
Average	2	If multiple UV charts overlap and have the same material, the average of all the instances determine the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.

Syntax

// Setter
void SetSurfaceAreaScale(ESurfaceAreaScale value);

// Getter
ESurfaceAreaScale GetSurfaceAreaScale();

SetSurfaceAreaScale parameters

Type	Name	Min	Max	Description
ESurfaceAreaScale	value			The SurfaceAreaScale value to use.

GetSurfaceAreaScale return value

Type: ESurfaceAreaScale

Default: LargestInstance

Key	Value	Comment
LargestInstance	0	If multiple UV charts overlap and have the same material, the largest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.
SmallestInstance	1	If multiple UV charts overlap and have the same material, the smallest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.
Average	2	If multiple UV charts overlap and have the same material, the average of all the instances determine the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.

Syntax

# Setter
None SetSurfaceAreaScale(value: ESurfaceAreaScale_*)

# Getter
ESurfaceAreaScale_* GetSurfaceAreaScale()

SetSurfaceAreaScale parameters

Name	Type	Min	Max	Description
value	ESurfaceAreaScale			The SurfaceAreaScale value to use.

GetSurfaceAreaScale return value

Type: ESurfaceAreaScale

Default: LargestInstance

Key	Value	Comment
ESurfaceAreaScale_LargestInstance	0	If multiple UV charts overlap and have the same material, the largest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.
ESurfaceAreaScale_SmallestInstance	1	If multiple UV charts overlap and have the same material, the smallest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.
ESurfaceAreaScale_Average	2	If multiple UV charts overlap and have the same material, the average of all the instances determine the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.

TexCoordLevel

Which TexCoord level to get charts from during re-parameterization. If a TexCoordName is set, it will override the TexCoordLevel.

Syntax

// Setter
void SetTexCoordLevel( unsigned int value ) const;

// Getter
unsigned int GetTexCoordLevel() const;

SetTexCoordLevel parameters

Type	Name	Min	Max	Description
unsigned int	value			The level/id of the TexCoord to use (i.e. 0-255).

GetTexCoordLevel return value

Type: unsigned int

Syntax

// Setter
void SetTexCoordLevel(uint value);

// Getter
uint GetTexCoordLevel();

SetTexCoordLevel parameters

Type	Name	Min	Max	Description
uint	value			The level/id of the TexCoord to use (i.e. 0-255).

GetTexCoordLevel return value

Type: uint

Syntax

# Setter
None SetTexCoordLevel(value: int)

# Getter
int GetTexCoordLevel()

SetTexCoordLevel parameters

Name	Type	Min	Max	Description
value	int			The level/id of the TexCoord to use (i.e. 0-255).

GetTexCoordLevel return value

Type: int

TexCoordName

Which TexCoord name to get charts from during re-parameterization.

Syntax

// Setter
void SetTexCoordName( const char * value ) const;

// Getter
spString GetTexCoordName() const;

SetTexCoordName parameters

Type	Name	Min	Max	Description
const char *	value			The name of the TexCoord to use (i.e. 'TexCoord0'-'TexCoord255').

GetTexCoordName return value

Type: spString

Syntax

// Setter
void SetTexCoordName(string value);

// Getter
string GetTexCoordName();

SetTexCoordName parameters

Type	Name	Min	Max	Description
string	value			The name of the TexCoord to use (i.e. 'TexCoord0'-'TexCoord255').

GetTexCoordName return value

Type: string

Syntax

# Setter
None SetTexCoordName(value: str)

# Getter
str GetTexCoordName()

SetTexCoordName parameters

Name	Type	Min	Max	Description
value	str			The name of the TexCoord to use (i.e. 'TexCoord0'-'TexCoord255').

GetTexCoordName return value

Type: str

TextureHeight

The height of the texture to use.

Syntax

// Setter
void SetTextureHeight( unsigned int value ) const;

// Getter
unsigned int GetTextureHeight() const;

SetTextureHeight parameters

Type	Name	Min	Max	Description
unsigned int	value			The texture height.

GetTextureHeight return value

Type: unsigned int

Syntax

// Setter
void SetTextureHeight(uint value);

// Getter
uint GetTextureHeight();

SetTextureHeight parameters

Type	Name	Min	Max	Description
uint	value			The texture height.

GetTextureHeight return value

Type: uint

Syntax

# Setter
None SetTextureHeight(value: int)

# Getter
int GetTextureHeight()

SetTextureHeight parameters

Name	Type	Min	Max	Description
value	int			The texture height.

GetTextureHeight return value

Type: int

TextureWidth

The width of the texture to use.

Syntax

// Setter
void SetTextureWidth( unsigned int value ) const;

// Getter
unsigned int GetTextureWidth() const;

SetTextureWidth parameters

Type	Name	Min	Max	Description
unsigned int	value			The texture width.

GetTextureWidth return value

Type: unsigned int

Syntax

// Setter
void SetTextureWidth(uint value);

// Getter
uint GetTextureWidth();

SetTextureWidth parameters

Type	Name	Min	Max	Description
uint	value			The texture width.

GetTextureWidth return value

Type: uint

Syntax

# Setter
None SetTextureWidth(value: int)

# Getter
int GetTextureWidth()

SetTextureWidth parameters

Name	Type	Min	Max	Description
value	int			The texture width.

GetTextureWidth return value

Type: int

UseAutomaticTextureSize

The automatic_texture_size flag. If true, then texture sizes will be computed for the reduced mesh depending on its pixel size on screen.

Syntax

// Setter
void SetUseAutomaticTextureSize( bool value ) const;

// Getter
bool GetUseAutomaticTextureSize() const;

SetUseAutomaticTextureSize parameters

Type	Name	Min	Max	Description
bool	value			The desired flag.

GetUseAutomaticTextureSize return value

Type: bool

Syntax

// Setter
void SetUseAutomaticTextureSize(bool value);

// Getter
bool GetUseAutomaticTextureSize();

SetUseAutomaticTextureSize parameters

Type	Name	Min	Max	Description
bool	value			The desired flag.

GetUseAutomaticTextureSize return value

Type: bool

Syntax

# Setter
None SetUseAutomaticTextureSize(value: bool)

# Getter
bool GetUseAutomaticTextureSize()

SetUseAutomaticTextureSize parameters

Name	Type	Min	Max	Description
value	bool			The desired flag.

GetUseAutomaticTextureSize return value

Type: bool

UseVertexWeights

The UseVertexWeights flag to scale the charts according to their vertex weights.

Syntax

// Setter
void SetUseVertexWeights( bool value ) const;

// Getter
bool GetUseVertexWeights() const;

SetUseVertexWeights parameters

Type	Name	Min	Max	Description
bool	value			The desired flag value.

GetUseVertexWeights return value

Type: bool

Syntax

// Setter
void SetUseVertexWeights(bool value);

// Getter
bool GetUseVertexWeights();

SetUseVertexWeights parameters

Type	Name	Min	Max	Description
bool	value			The desired flag value.

GetUseVertexWeights return value

Type: bool

Syntax

# Setter
None SetUseVertexWeights(value: bool)

# Getter
bool GetUseVertexWeights()

SetUseVertexWeights parameters

Name	Type	Min	Max	Description
value	bool			The desired flag value.

GetUseVertexWeights return value

Type: bool

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

Syntax

int AddObserver(spObserver observer);

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

Parameters

Name	Type	Min	Max	Description
observer	Observer			Observer is the object that will receive events.

Return value

Type: int

GetClass

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

Syntax

spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

GetGutterSpaceForMaterialIndex

The minimum number of pixels between charts.

Syntax

unsigned int GetGutterSpaceForMaterialIndex( unsigned int id ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	id			The output material ID.

Return value

Type: unsigned int

Syntax

uint GetGutterSpaceForMaterialIndex(uint id);

Parameters

Type	Name	Min	Max	Description
uint	id			The output material ID.

Return value

Type: uint

Syntax

int GetGutterSpaceForMaterialIndex(id: int)

Parameters

Name	Type	Min	Max	Description
id	int			The output material ID.

Return value

Type: int

GetInputOutputMaterialMapping

The previously set material mapping for matId.

Syntax

int GetInputOutputMaterialMapping( unsigned int inMaterialId ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	inMaterialId			The input material ID.

Return value

Type: int

Syntax

int GetInputOutputMaterialMapping(uint inMaterialId);

Parameters

Type	Name	Min	Max	Description
uint	inMaterialId			The input material ID.

Return value

Type: int

Syntax

int GetInputOutputMaterialMapping(inMaterialId: int)

Parameters

Name	Type	Min	Max	Description
inMaterialId	int			The input material ID.

Return value

Type: int

GetKeepOriginalChartSizesTextureHeight

If KeepOriginalChartSizes is enabled: calling GetKeepOriginalChartSizesTextureWidth and GetKeepOriginalChartSizesTextureHeight after parameterization will return the final texture sizes.

Syntax

unsigned int GetKeepOriginalChartSizesTextureHeight() const;

Parameters

GetKeepOriginalChartSizesTextureHeight takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetKeepOriginalChartSizesTextureHeight();

Parameters

GetKeepOriginalChartSizesTextureHeight takes no parameters.

Return value

Type: uint

Syntax

int GetKeepOriginalChartSizesTextureHeight()

Parameters

GetKeepOriginalChartSizesTextureHeight takes no parameters.

Return value

Type: int

GetKeepOriginalChartSizesTextureHeightForMaterialIndex

If KeepOriginalChartSizes is enabled: calling GetKeepOriginalChartSizesTextureWidth and GetKeepOriginalChartSizesTextureHeight after parameterization will return the final texture sizes.

Syntax

unsigned int GetKeepOriginalChartSizesTextureHeightForMaterialIndex( unsigned int outputId ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	outputId			The outputId.

Return value

Type: unsigned int

Syntax

uint GetKeepOriginalChartSizesTextureHeightForMaterialIndex(uint outputId);

Parameters

Type	Name	Min	Max	Description
uint	outputId			The outputId.

Return value

Type: uint

Syntax

int GetKeepOriginalChartSizesTextureHeightForMaterialIndex(outputId: int)

Parameters

Name	Type	Min	Max	Description
outputId	int			The outputId.

Return value

Type: int

GetKeepOriginalChartSizesTextureWidth

If KeepOriginalChartSizes is enabled: calling GetKeepOriginalChartSizesTextureWidth and GetKeepOriginalChartSizesTextureHeight after parameterization will return the final texture sizes.

Syntax

unsigned int GetKeepOriginalChartSizesTextureWidth() const;

Parameters

GetKeepOriginalChartSizesTextureWidth takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetKeepOriginalChartSizesTextureWidth();

Parameters

GetKeepOriginalChartSizesTextureWidth takes no parameters.

Return value

Type: uint

Syntax

int GetKeepOriginalChartSizesTextureWidth()

Parameters

GetKeepOriginalChartSizesTextureWidth takes no parameters.

Return value

Type: int

GetKeepOriginalChartSizesTextureWidthForMaterialIndex

If KeepOriginalChartSizes is enabled: calling GetKeepOriginalChartSizesTextureWidth and GetKeepOriginalChartSizesTextureHeight after parameterization will return the final texture sizes.

Syntax

unsigned int GetKeepOriginalChartSizesTextureWidthForMaterialIndex( unsigned int outputId ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	outputId			The outputId.

Return value

Type: unsigned int

Syntax

uint GetKeepOriginalChartSizesTextureWidthForMaterialIndex(uint outputId);

Parameters

Type	Name	Min	Max	Description
uint	outputId			The outputId.

Return value

Type: uint

Syntax

int GetKeepOriginalChartSizesTextureWidthForMaterialIndex(outputId: int)

Parameters

Name	Type	Min	Max	Description
outputId	int			The outputId.

Return value

Type: int

GetTextureHeightForMaterialIndex

The height of the texture to use.

Syntax

unsigned int GetTextureHeightForMaterialIndex( unsigned int id ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	id			The output material ID.

Return value

Type: unsigned int

Syntax

uint GetTextureHeightForMaterialIndex(uint id);

Parameters

Type	Name	Min	Max	Description
uint	id			The output material ID.

Return value

Type: uint

Syntax

int GetTextureHeightForMaterialIndex(id: int)

Parameters

Name	Type	Min	Max	Description
id	int			The output material ID.

Return value

Type: int

GetTextureWidthForMaterialIndex

The width of the texture to use.

Syntax

unsigned int GetTextureWidthForMaterialIndex( unsigned int id ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	id			The output material ID.

Return value

Type: unsigned int

Syntax

uint GetTextureWidthForMaterialIndex(uint id);

Parameters

Type	Name	Min	Max	Description
uint	id			The output material ID.

Return value

Type: uint

Syntax

int GetTextureWidthForMaterialIndex(id: int)

Parameters

Name	Type	Min	Max	Description
id	int			The output material ID.

Return value

Type: int

IsA

Returns true if ChartAggregator 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 ChartAggregator is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(string type);

Parameters

Type	Name	Min	Max	Description
string	type			Name of the class to check if ChartAggregator is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			Name of the class to check if ChartAggregator is, or is a descendant of.

Return value

Type: bool

IsNull

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

Syntax

bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

Returns true if the ChartAggregator 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

Syntax

bool IsSameObjectAs(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to compare with.

Return value

Type: bool

NonNull

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

Syntax

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

Parameters

NonNull takes no parameters.

Return value

Type: bool

Parameterize

Executes the parameterization of the geometry.

Syntax

bool Parameterize( const spGeometryData & geom , const spRealArray & arr ) const;

Parameters

Type	Name	Min	Max	Description
GeometryData	geom			The geometry which is to be parameterized.
RealArray	arr			The array where the result is stored.

Return value

Type: bool

Syntax

bool Parameterize(spGeometryData geom, spRealArray arr);

Parameters

Type	Name	Min	Max	Description
GeometryData	geom			The geometry which is to be parameterized.
RealArray	arr			The array where the result is stored.

Return value

Type: bool

Syntax

bool Parameterize(geom: spGeometryData, arr: spRealArray)

Parameters

Name	Type	Min	Max	Description
geom	GeometryData			The geometry which is to be parameterized.
arr	RealArray			The array where the result is stored.

Return value

Type: bool

PrintInfo

Prints the content/info of the ChartAggregator object to the log. (Inherited from Object)

Syntax

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

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.

Syntax

void RemoveObserver(int observerId);

Parameters

Type	Name	Min	Max	Description
int	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

None RemoveObserver(observerId: int)

Parameters

Name	Type	Min	Max	Description
observerId	int			ObserverId is the id returned by AddObserver when the observer was added.

SetGutterSpaceForMaterialIndex

The minimum number of pixels between charts.

Syntax

void SetGutterSpaceForMaterialIndex( unsigned int id , unsigned int value ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	id			The output material ID.
unsigned int	value			The value to which GutterSpace will be set.

Syntax

void SetGutterSpaceForMaterialIndex(uint id, uint value);

Parameters

Type	Name	Min	Max	Description
uint	id			The output material ID.
uint	value			The value to which GutterSpace will be set.

Syntax

None SetGutterSpaceForMaterialIndex(id: int, value: int)

Parameters

Name	Type	Min	Max	Description
id	int			The output material ID.
value	int			The value to which GutterSpace will be set.

SetInputOutputMaterialMapping

The material mapping for inMaterialId, meaning what material of the generated LOD inMaterialId will be baked into. Both InputMaterialCount and OutputMaterialCount need to be set for this mapping to work, and all original materials need to be mapped to an existing output id.

Syntax

void SetInputOutputMaterialMapping( unsigned int inMaterialId , int outMaterialId ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	inMaterialId			The input materialId.
int	outMaterialId			The output materialId.

Syntax

void SetInputOutputMaterialMapping(uint inMaterialId, int outMaterialId);

Parameters

Type	Name	Min	Max	Description
uint	inMaterialId			The input materialId.
int	outMaterialId			The output materialId.

Syntax

None SetInputOutputMaterialMapping(inMaterialId: int, outMaterialId: int)

Parameters

Name	Type	Min	Max	Description
inMaterialId	int			The input materialId.
outMaterialId	int			The output materialId.

SetMaterialTable

The scene material table.

Syntax

void SetMaterialTable( const spMaterialTable & value ) const;

Parameters

Type	Name	Min	Max	Description
MaterialTable	value			The scene material table.

Syntax

void SetMaterialTable(spMaterialTable value);

Parameters

Type	Name	Min	Max	Description
MaterialTable	value			The scene material table.

Syntax

None SetMaterialTable(value: spMaterialTable)

Parameters

Name	Type	Min	Max	Description
value	MaterialTable			The scene material table.

SetSeparateOverlappingCharts

The Separate Overlapping Charts flag. If charts are overlapping in the original texture coords, they will be separated.

Syntax

void SetSeparateOverlappingCharts( bool value ) const;

Parameters

Type	Name	Min	Max	Description
bool	value			The desired flag value.

Syntax

void SetSeparateOverlappingCharts(bool value);

Parameters

Type	Name	Min	Max	Description
bool	value			The desired flag value.

Syntax

None SetSeparateOverlappingCharts(value: bool)

Parameters

Name	Type	Min	Max	Description
value	bool			The desired flag value.

SetTextureHeightForMaterialIndex

The height of the texture to use.

Syntax

void SetTextureHeightForMaterialIndex( unsigned int id , unsigned int value ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	id			The output material ID.
unsigned int	value			The texture height.

Syntax

void SetTextureHeightForMaterialIndex(uint id, uint value);

Parameters

Type	Name	Min	Max	Description
uint	id			The output material ID.
uint	value			The texture height.

Syntax

None SetTextureHeightForMaterialIndex(id: int, value: int)

Parameters

Name	Type	Min	Max	Description
id	int			The output material ID.
value	int			The texture height.

SetTextureTable

The scene texture table.

Syntax

void SetTextureTable( const spTextureTable & value ) const;

Parameters

Type	Name	Min	Max	Description
TextureTable	value			The scene texture table.

Syntax

void SetTextureTable(spTextureTable value);

Parameters

Type	Name	Min	Max	Description
TextureTable	value			The scene texture table.

Syntax

None SetTextureTable(value: spTextureTable)

Parameters

Name	Type	Min	Max	Description
value	TextureTable			The scene texture table.

SetTextureWidthForMaterialIndex

The width of the texture to use.

Syntax

void SetTextureWidthForMaterialIndex( unsigned int id , unsigned int value ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	id			The output material ID.
unsigned int	value			The texture width.

Syntax

void SetTextureWidthForMaterialIndex(uint id, uint value);

Parameters

Type	Name	Min	Max	Description
uint	id			The output material ID.
uint	value			The texture width.

Syntax

None SetTextureWidthForMaterialIndex(id: int, value: int)

Parameters

Name	Type	Min	Max	Description
id	int			The output material ID.
value	int			The texture width.

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

Syntax

static bool IsClassA(string type);

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

@staticmethod
bool IsClassA(type: str)

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 spChartAggregator, and if this is the case, returns the object cast into spChartAggregator. (Inherited from Object)

Syntax

static spChartAggregator SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ChartAggregator

Syntax

static spChartAggregator SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ChartAggregator

Syntax

@staticmethod
spChartAggregator SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: ChartAggregator