SimplygonSDK::IDisplacementCasterSettings Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IDisplacementCasterSettings:

Public Member Functions
virtual const char *	GetClass ()
virtual real	GetDistanceScaling ()=0
virtual bool	GetGenerateScalarDisplacement ()=0
virtual bool	GetGenerateTangentSpaceDisplacement ()=0
virtual rid	GetNormalMapTextureLevel ()=0
virtual bool	IsA (const char *type) const
virtual void	SetDistanceScaling (real value)=0
virtual void	SetGenerateScalarDisplacement (bool value)=0
virtual void	SetGenerateTangentSpaceDisplacement (bool value)=0
virtual void	SetNormalMapTextureLevel (rid value)=0
Public Member Functions inherited from SimplygonSDK::IMaterialCasterSettings
virtual unsigned int	GetDilation ()=0
virtual unsigned int	GetDitherType ()=0
virtual int	GetFillMode ()=0
virtual rstring	GetMaterialChannel ()=0
virtual unsigned int	GetOutputChannelBitDepth ()=0
virtual unsigned int	GetOutputChannels ()=0
virtual bool	GetUseMultisampling ()=0
virtual void	SetDilation (unsigned int value)=0
virtual void	SetDitherType (unsigned int value)=0
virtual void	SetFillMode (int value)=0
virtual void	SetMaterialChannel (const char *value)=0
virtual void	SetOutputChannelBitDepth (unsigned int value)=0
virtual void	SetOutputChannels (unsigned int value)=0
virtual void	SetUseMultisampling (bool 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 IDisplacementCasterSettings *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IMaterialCasterSettings
static bool	IsClassA (const char *type)
static IMaterialCasterSettings *	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

IDisplacementCasterSettings is used to store the settings for a displacement caster

Definition at line 10503 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

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

GetDistanceScaling()

virtual real SimplygonSDK::IDisplacementCasterSettings::GetDistanceScaling ( )

pure virtual

Get the DistanceScaling value. All the delta values are divided by this value before storing them into an image.

Returns

The current DistanceScaling value

GetGenerateScalarDisplacement()

virtual bool SimplygonSDK::IDisplacementCasterSettings::GetGenerateScalarDisplacement ( )

pure virtual

Get the GenerateScalarDisplacement value. If set to true, the size of the displacement vectors' components in the direction of the interpolated normal are stored in the displacement map, instead of the displacement vectors.

Returns

The current GenerateScalarDisplacement flag

GetGenerateTangentSpaceDisplacement()

virtual bool SimplygonSDK::IDisplacementCasterSettings::GetGenerateTangentSpaceDisplacement ( )

pure virtual

Get the GenerateTangentSpaceDisplacement value. If set, the displacement vectors are transformed into the destination objects' tangent space

Returns

The current GenerateTangentSpaceDisplacement flag

GetNormalMapTextureLevel()

virtual rid SimplygonSDK::IDisplacementCasterSettings::GetNormalMapTextureLevel ( )

pure virtual

Get the texture coordinate level to use for the tangent space displacement vectors.

Returns

The current NormalMapTextureLevel value

IsA()

virtual bool SimplygonSDK::IDisplacementCasterSettings::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::IMaterialCasterSettings.

IsClassA()

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

inlinestatic

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

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IDisplacementCasterSettings pointer

Returns

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

Definition at line 10537 of file SimplygonSDK.h.

SetDistanceScaling()

virtual void SimplygonSDK::IDisplacementCasterSettings::SetDistanceScaling ( real  value )

pure virtual

Set the DistanceScaling value. All the delta values are divided by this value before storing them into an image.

Parameters

value

The desired DistanceScaling value

SetGenerateScalarDisplacement()

virtual void SimplygonSDK::IDisplacementCasterSettings::SetGenerateScalarDisplacement ( bool  value )

pure virtual

Set the GenerateScalarDisplacement value. If set to true, the size of the displacement vectors' components in the direction of the interpolated normal are stored in the displacement map, instead of the displacement vectors.

Parameters

value

The desired GenerateScalarDisplacement flag

SetGenerateTangentSpaceDisplacement()

virtual void SimplygonSDK::IDisplacementCasterSettings::SetGenerateTangentSpaceDisplacement ( bool  value )

pure virtual

Set the GenerateTangentSpaceDisplacement value. If set, the displacement vectors are transformed into the destination objects' tangent space

Parameters

value

The desired GenerateTangentSpaceDisplacement flag

SetNormalMapTextureLevel()

virtual void SimplygonSDK::IDisplacementCasterSettings::SetNormalMapTextureLevel ( rid  value )

pure virtual

Set the texture coordinate level to use for the tangent space displacement vectors.

Parameters

value

The desired NormalMapTextureLevel value

---

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

• SimplygonSDK.h