SimplygonSDK::IAggregationSettings Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IAggregationSettings:

Public Member Functions
virtual bool	GetBaseAtlasOnOriginalTexCoords ()=0
virtual const char *	GetClass ()
virtual bool	GetMergeGeometries ()=0
virtual bool	GetMergeMaterials ()=0
virtual rid	GetProcessSelectionSetID ()=0
virtual rstring	GetProcessSelectionSetName ()=0
virtual bool	GetSubdivideGeometryBasedOnUVTiles ()=0
virtual unsigned int	GetSubdivisionTileSize ()=0
virtual bool	IsA (const char *type) const
virtual void	SetBaseAtlasOnOriginalTexCoords (bool value)=0
virtual void	SetMergeGeometries (bool value)=0
virtual void	SetMergeMaterials (bool value)=0
virtual void	SetProcessSelectionSetID (rid value)=0
virtual void	SetProcessSelectionSetName (const char *value)=0
virtual void	SetSubdivideGeometryBasedOnUVTiles (bool value)=0
virtual void	SetSubdivisionTileSize (unsigned int value)=0
Public Member Functions inherited from SimplygonSDK::ISettingsObject
virtual rstring	GetErrorString ()=0
virtual bool	ValidateSettings ()=0
Public Member Functions inherited from SimplygonSDK::IObject
virtual rid	AddObserver (robserver *Observer, rid EventId)=0
virtual void	AddRef ()=0
virtual rstring	GetName ()=0
virtual void *	GetUserComponentArea (rid userid)=0
virtual void	PrintInfo ()=0
virtual void	Release ()=0
virtual void	RemoveObserver (rid ObserverId)=0
virtual void	SetName (const char *Name)=0

Static Public Member Functions
static bool	IsClassA (const char *type)
static IAggregationSettings *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::ISettingsObject
static bool	IsClassA (const char *type)
static ISettingsObject *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

Settings for the IAggregationSettings class. The AggregationProcessor converts entire scenes containing multiple draw calls into a single new object with a single texture per material channel. The user can set whether or not the AggregationProcessor should create new UVs based on the old UVs or create a completely new UV parameterization.

Definition at line 18219 of file SimplygonSDK.h.

Member Function Documentation

GetBaseAtlasOnOriginalTexCoords()

virtual bool SimplygonSDK::IAggregationSettings::GetBaseAtlasOnOriginalTexCoords ( )

pure virtual

Sets whether the new texture coords should be based on the original texture coords and the charts only rotated in multiples of 90 degrees, or if the scene should have completely new texture coords.

Returns

the current flag value

GetClass()

virtual const char* SimplygonSDK::IAggregationSettings::GetClass ( )

virtual

GetClass returns the name of the class of the object.

Returns

the name of the actual class of the object, as a const char string

Reimplemented from SimplygonSDK::ISettingsObject.

GetMergeGeometries()

virtual bool SimplygonSDK::IAggregationSettings::GetMergeGeometries ( )

pure virtual

The processor will merge all the geometries in the scene into a single geometry if MergeGeometries is enabled.

Returns

value the current MergeGeometries flag

GetMergeMaterials()

virtual bool SimplygonSDK::IAggregationSettings::GetMergeMaterials ( )

pure virtual

If true, the processor will merge all the materials in the scene to a new one and generate a mapping image using the relevant mapping image settings for casting. If false, the materials are kept untouched.

Returns

value the current MergeGeometries flag

GetProcessSelectionSetID()

virtual rid SimplygonSDK::IAggregationSettings::GetProcessSelectionSetID ( )

pure virtual

Selects which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed.

Returns

the current SelectionSet id

GetProcessSelectionSetName()

virtual rstring SimplygonSDK::IAggregationSettings::GetProcessSelectionSetName ( )

pure virtual

Selects which SelectionSet should be processed. If set to NULL, all geometries in the scene will be processed. If both ID and Name are set, ID will be used.

Returns

the current SelectionSet name

GetSubdivideGeometryBasedOnUVTiles()

virtual bool SimplygonSDK::IAggregationSettings::GetSubdivideGeometryBasedOnUVTiles ( )

pure virtual

Subdivides the geometry based on the tiling texture coords. The cutting frequency "SubdivisionTileSize" is a positive integer multiplier. (i.e. the mesh will be cut each time its U or V texcoords crosses the SubdivisionTileSize). The output UVs will be in the range [(0,0),(SubdivisionTileSize,SubdivisionTileSize)]

Returns

value the current SubdivideGeometryBasedOnUVTiles flag

GetSubdivisionTileSize()

virtual unsigned int SimplygonSDK::IAggregationSettings::GetSubdivisionTileSize ( )

pure virtual

The cutting frequency used when SubdivideGeometryBasedOnUVTiles is enabled.

Returns

value the current SubdivisionTileSize value

IsA()

virtual bool SimplygonSDK::IAggregationSettings::IsA ( const char *  type ) const

virtual

The IsA function returns true if the object is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the object is, or is a descendant of

Returns

true if the object is of the specified class, false if not

Reimplemented from SimplygonSDK::ISettingsObject.

IsClassA()

static bool SimplygonSDK::IAggregationSettings::IsClassA ( const char *  type )

inlinestatic

The IsClassA function returns true if IAggregationSettings is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the class is, or is a descendant of

Returns

true if the class is of the specified class, false if not

Definition at line 18240 of file SimplygonSDK.h.

SafeCast()

static IAggregationSettings* SimplygonSDK::IAggregationSettings::SafeCast ( IObject *  ptr )

inlinestatic

SafeCast makes sure the pointer is of a class that can be cast into a IAggregationSettings pointer, and if this is possible, returns the cast pointer.

Parameters

ptr	is the pointer to be cast into a IAggregationSettings pointer

Returns

a pointer to the IAggregationSettings object, if the cast can be made, and a NULL pointer otherwise

Definition at line 18253 of file SimplygonSDK.h.

SetBaseAtlasOnOriginalTexCoords()

virtual void SimplygonSDK::IAggregationSettings::SetBaseAtlasOnOriginalTexCoords ( bool  value )

pure virtual

Sets whether the new texture coords should be based on the original texture coords and the charts only rotated in multiples of 90 degrees, or if the scene should have completely new texture coords.

Parameters

value

set to true if the new texture coords should be based on the original texture coords.

SetMergeGeometries()

virtual void SimplygonSDK::IAggregationSettings::SetMergeGeometries ( bool  value )

pure virtual

The processor will merge all the geometries in the scene into a single geometry if MergeGeometries is enabled.

Parameters

value

the desired MergeGeometries flag

SetMergeMaterials()

virtual void SimplygonSDK::IAggregationSettings::SetMergeMaterials ( bool  value )

pure virtual

If true, the processor will merge all the materials in the scene to a new one and generate a mapping image using the relevant mapping image settings for casting. If false, the materials are kept untouched.

Parameters

value

the desired MergeGeometries flag

SetProcessSelectionSetID()

virtual void SimplygonSDK::IAggregationSettings::SetProcessSelectionSetID ( rid  value )

pure virtual

Selects which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed.

Parameters

value

the desired SelectionSet id

SetProcessSelectionSetName()

virtual void SimplygonSDK::IAggregationSettings::SetProcessSelectionSetName ( const char *  value )

pure virtual

Selects which SelectionSet should be processed. If SetName is not found, all geometries in the scene will be processed. If both ID and Name are set, ID will be used.

Parameters

value

the desired SelectionSet name

SetSubdivideGeometryBasedOnUVTiles()

virtual void SimplygonSDK::IAggregationSettings::SetSubdivideGeometryBasedOnUVTiles ( bool  value )

pure virtual

Subdivides the geometry based on the tiling texture coords. The cutting frequency "SubdivisionTileSize" is a positive integer multiplier. (i.e. the mesh will be cut each time its U or V texcoords crosses the SubdivisionTileSize). The output UVs will be in the range [(0,0),(SubdivisionTileSize,SubdivisionTileSize)]

Parameters

value

the desired SubdivideGeometryBasedOnUVTiles flag

SetSubdivisionTileSize()

virtual void SimplygonSDK::IAggregationSettings::SetSubdivisionTileSize ( unsigned int  value )

pure virtual

The cutting frequency used when SubdivideGeometryBasedOnUVTiles is enabled.

Parameters

value

the desired SubdivisionTileSize value

---

The documentation for this class was generated from the following file:

• SimplygonSDK.h