SimplygonSDK::IAggregationProcessor Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IAggregationProcessor:

Public Member Functions
virtual CountedPointer< IAggregationSettings >	GetAggregationSettings ()=0
virtual const char *	GetClass ()
virtual CountedPointer< IMappingImage >	GetMappingImage ()=0
virtual CountedPointer< IMappingImageSettings >	GetMappingImageSettings ()=0
virtual CountedPointer< IScene >	GetScene ()=0
virtual CountedPointer< IVisibilitySettings >	GetVisibilitySettings ()=0
virtual bool	IsA (const char *type) const
virtual void	SetScene (IScene *value)=0
Public Member Functions inherited from SimplygonSDK::IProcessingObject
virtual void	Clear ()=0
virtual real	GetPercentDone ()=0
virtual void	RunProcessing ()=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 IAggregationProcessor *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IProcessingObject
static bool	IsClassA (const char *type)
static IProcessingObject *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

IAggregationProcessor combines all specified geometries in the scene into one geometry. All materials are combined and receive a new shared texture atlas.

Definition at line 18118 of file SimplygonSDK.h.

Member Function Documentation

GetAggregationSettings()

virtual CountedPointer<IAggregationSettings> SimplygonSDK::IAggregationProcessor::GetAggregationSettings ( )

pure virtual

The settings for the combining process.

Returns

the combining settings object

GetClass()

virtual const char* SimplygonSDK::IAggregationProcessor::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::IProcessingObject.

GetMappingImage()

virtual CountedPointer<IMappingImage> SimplygonSDK::IAggregationProcessor::GetMappingImage ( )

pure virtual

Get the MappingImage object that is generated if MappingImageSettings::GenerateMappingImage is set. The object is of type IMappingImage. A new object is generated for each call to RunProcessing().

Returns

the current mapping image

GetMappingImageSettings()

virtual CountedPointer<IMappingImageSettings> SimplygonSDK::IAggregationProcessor::GetMappingImageSettings ( )

pure virtual

The settings for the image mapping process.

Returns

the mapping image settings object

GetScene()

virtual CountedPointer<IScene> SimplygonSDK::IAggregationProcessor::GetScene ( )

pure virtual

Get the scene used for aggregation processing. Please note that internal refrences might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

Returns

the current scene

GetVisibilitySettings()

virtual CountedPointer<IVisibilitySettings> SimplygonSDK::IAggregationProcessor::GetVisibilitySettings ( )

pure virtual

The settings for handling visibility weights.

Returns

the visibility settings object associated with the processor

IsA()

virtual bool SimplygonSDK::IAggregationProcessor::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::IProcessingObject.

IsClassA()

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

inlinestatic

The IsClassA function returns true if IAggregationProcessor 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 18139 of file SimplygonSDK.h.

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IAggregationProcessor pointer

Returns

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

Definition at line 18152 of file SimplygonSDK.h.

SetScene()

virtual void SimplygonSDK::IAggregationProcessor::SetScene ( IScene *  value )

pure virtual

Set the scene used for aggregation processing. Please note that internal refrences might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

Parameters

value

the scene to process

---

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

• SimplygonSDK.h