SimplygonSDK::ISettingsObject Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::ISettingsObject:

Public Member Functions
virtual const char *	GetClass ()
virtual rstring	GetErrorString ()=0
virtual bool	IsA (const char *type) const
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 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

ISettingsObject is the abstract base class for all settings objects in Simplygon. Settings objects contains parameters for processing objects to use. These settings objects will have their data set and reached from a IProcessingObject and then used therein.

Definition at line 8997 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

virtual const char* SimplygonSDK::ISettingsObject::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::IPipelineSettings, SimplygonSDK::IShadowMeshSettings, SimplygonSDK::IFoliageSettings, SimplygonSDK::IOcclusionMeshSettings, SimplygonSDK::IImpostorSettings, SimplygonSDK::IAmbientOcclusionCasterSettings, SimplygonSDK::IAggregationSettings, SimplygonSDK::IRemeshingSettingsV2, SimplygonSDK::IRemeshingSettings, SimplygonSDK::IVisibilitySettings, SimplygonSDK::IMappingImageSettings, SimplygonSDK::INormalCalculationSettings, SimplygonSDK::IReductionSettings, SimplygonSDK::IBoneSettings, SimplygonSDK::IRepairSettings, SimplygonSDK::IDisplacementCasterSettings, SimplygonSDK::INormalCasterSettings, SimplygonSDK::IOpacityCasterSettings, SimplygonSDK::IColorCasterSettings, and SimplygonSDK::IMaterialCasterSettings.

GetErrorString()

virtual rstring SimplygonSDK::ISettingsObject::GetErrorString ( )

pure virtual

Returns a string describing the error that was found the last time ValidateSettings was performed.

Returns

the last string describing the error

IsA()

virtual bool SimplygonSDK::ISettingsObject::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::IPipelineSettings, SimplygonSDK::IShadowMeshSettings, SimplygonSDK::IFoliageSettings, SimplygonSDK::IOcclusionMeshSettings, SimplygonSDK::IImpostorSettings, SimplygonSDK::IAmbientOcclusionCasterSettings, SimplygonSDK::IAggregationSettings, SimplygonSDK::IRemeshingSettingsV2, SimplygonSDK::IRemeshingSettings, SimplygonSDK::IVisibilitySettings, SimplygonSDK::IMappingImageSettings, SimplygonSDK::INormalCalculationSettings, SimplygonSDK::IReductionSettings, SimplygonSDK::IBoneSettings, SimplygonSDK::IRepairSettings, SimplygonSDK::IDisplacementCasterSettings, SimplygonSDK::INormalCasterSettings, SimplygonSDK::IOpacityCasterSettings, SimplygonSDK::IColorCasterSettings, and SimplygonSDK::IMaterialCasterSettings.

IsClassA()

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

inlinestatic

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

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a ISettingsObject pointer

Returns

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

Definition at line 9031 of file SimplygonSDK.h.

ValidateSettings()

virtual bool SimplygonSDK::ISettingsObject::ValidateSettings ( )

pure virtual

Validates the current settings values.

Returns

true if all settings are valid

---

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

• SimplygonSDK.h