SimplygonSDK::IShadowMeshSettings Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IShadowMeshSettings:

Public Member Functions
virtual const char *	GetClass ()
virtual unsigned int	GetOnScreenErrorTolerance ()=0
virtual unsigned int	GetOnScreenSize ()=0
virtual bool	IsA (const char *type) const
virtual void	SetOnScreenErrorTolerance (unsigned int value)=0
virtual void	SetOnScreenSize (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 IShadowMeshSettings *	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 shadow meshes

Definition at line 20522 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

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

GetOnScreenErrorTolerance()

virtual unsigned int SimplygonSDK::IShadowMeshSettings::GetOnScreenErrorTolerance ( )

pure virtual

Get the fidelity. This determines how large of an error that is tolerated, in pixels. Valid range is 1-50. Since this setting is based around the absolute worst-case scenario, you can usually get good results at relatively high tolerances.

Returns

the current silhouette fidelity

GetOnScreenSize()

virtual unsigned int SimplygonSDK::IShadowMeshSettings::GetOnScreenSize ( )

pure virtual

Get the the onscreen size (px) of the output utility mesh. This will determine triangle count and quality.

Returns

the current silhouette fidelity

IsA()

virtual bool SimplygonSDK::IShadowMeshSettings::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::IShadowMeshSettings::IsClassA ( const char *  type )

inlinestatic

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

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IShadowMeshSettings pointer

Returns

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

Definition at line 20556 of file SimplygonSDK.h.

SetOnScreenErrorTolerance()

virtual void SimplygonSDK::IShadowMeshSettings::SetOnScreenErrorTolerance ( unsigned int  value )

pure virtual

Set the fidelity. This determines how large of an error that is tolerated, in pixels. Valid range is 1-50. Since this setting is based around the absolute worst-case scenario, you can usually get good results at relatively high tolerances.

Parameters

value

the desired silhouette fidelity

SetOnScreenSize()

virtual void SimplygonSDK::IShadowMeshSettings::SetOnScreenSize ( unsigned int  value )

pure virtual

Set the onscreen size (px) of the output utility mesh. This will determine triangle count and quality.

Parameters

value

the desired silhouette fidelity

---

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

• SimplygonSDK.h