SimplygonSDK::IProcessingObject Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IProcessingObject:

Public Member Functions
virtual void	Clear ()=0
virtual const char *	GetClass ()
virtual real	GetPercentDone ()=0
virtual bool	IsA (const char *type) const
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 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

IProcessingObject is the abstract base class for all processing objects in Simplygon. Processing objects take parameters, exports the RunProcessing to run the main processing and Clear to clear the internal states of the processing object. All processing objects also export information on how far the process has moved and the possibility to cancel long running processings.

Definition at line 7741 of file SimplygonSDK.h.

Member Function Documentation

Clear()

virtual void SimplygonSDK::IProcessingObject::Clear ( )

pure virtual

Clear all internal states of the object. This will NOT clear the parameters set in the object.

GetClass()

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

Reimplemented in SimplygonSDK::IWelder, SimplygonSDK::IShadowMeshProcessor, SimplygonSDK::IFoliageProcessor, SimplygonSDK::IOcclusionMeshProcessor, SimplygonSDK::IImpostorProcessor, SimplygonSDK::IAmbientOcclusionCaster, SimplygonSDK::IAggregationProcessor, SimplygonSDK::IRemeshingProcessorV2, SimplygonSDK::IRemeshingProcessor, SimplygonSDK::IReductionProcessor, SimplygonSDK::IDisplacementCaster, SimplygonSDK::INormalRepairer, SimplygonSDK::INormalCaster, SimplygonSDK::IOpacityCaster, SimplygonSDK::IColorCaster, and SimplygonSDK::IMaterialCaster.

GetPercentDone()

virtual real SimplygonSDK::IProcessingObject::GetPercentDone ( )

pure virtual

Returns the current progress of the processing as a value between 0 and 100

Returns

The current progress of the process as a value between 0 and 100.

IsA()

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

Reimplemented in SimplygonSDK::IWelder, SimplygonSDK::IShadowMeshProcessor, SimplygonSDK::IFoliageProcessor, SimplygonSDK::IOcclusionMeshProcessor, SimplygonSDK::IImpostorProcessor, SimplygonSDK::IAmbientOcclusionCaster, SimplygonSDK::IAggregationProcessor, SimplygonSDK::IRemeshingProcessorV2, SimplygonSDK::IRemeshingProcessor, SimplygonSDK::IReductionProcessor, SimplygonSDK::IDisplacementCaster, SimplygonSDK::INormalRepairer, SimplygonSDK::INormalCaster, SimplygonSDK::IOpacityCaster, SimplygonSDK::IColorCaster, and SimplygonSDK::IMaterialCaster.

IsClassA()

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

inlinestatic

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

RunProcessing()

virtual void SimplygonSDK::IProcessingObject::RunProcessing ( )

pure virtual

Runs the processing the object is designed for

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IProcessingObject pointer

Returns

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

Definition at line 7775 of file SimplygonSDK.h.

---

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

• SimplygonSDK.h