#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IDisplacementCaster:

Public Member Functions
virtual const char *	GetClass ()

virtual CountedPointer< IDisplacementCasterSettings >	GetDisplacementCasterSettings ()=0

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 DistanceScaling)=0

virtual void	SetGenerateScalarDisplacement (bool GenerateScalarDisplacement)=0

virtual void	SetGenerateTangentSpaceDisplacement (bool GenerateTangentSpaceDisplacement)=0

virtual void	SetNormalMapTextureLevel (rid NormalMapTextureLevel)=0

Public Member Functions inherited from SimplygonSDK::IMaterialCaster
virtual SGDEPRECATED void	CastMaterials ()=0

virtual CountedPointer< IMaterialCasterSettings >	GetCasterSettings ()=0

virtual rid	GetDestMaterialId ()=0

virtual unsigned int	GetDilation ()=0

virtual unsigned int	GetDitherType ()=0

virtual unsigned int	GetFillMode ()=0

virtual CountedPointer< IMappingImage >	GetMappingImage ()=0

virtual unsigned int	GetOutputChannelBitDepth ()=0

virtual unsigned int	GetOutputChannels ()=0

virtual rstring	GetOutputFilePath ()=0

virtual CountedPointer< IImageData >	GetOutputImage ()=0

virtual CountedPointer< IMaterialTable >	GetSourceMaterials ()=0

virtual CountedPointer< ITextureTable >	GetSourceTextures ()=0

virtual bool	GetUseMultisampling ()=0

virtual void	SetDestMaterialId (rid value)=0

virtual void	SetDilation (unsigned int Dilation)=0

virtual void	SetDitherType (unsigned int DitherType)=0

virtual void	SetFillMode (unsigned int FillMode)=0

virtual void	SetMappingImage (IMappingImage *value)=0

virtual void	SetOutputChannelBitDepth (unsigned int OutputChannelBitDepth)=0

virtual void	SetOutputChannels (unsigned int OutputChannels)=0

virtual void	SetOutputFilePath (const char *value)=0

virtual void	SetOutputImage (IImageData *value)=0

virtual void	SetSourceMaterials (IMaterialTable *value)=0

virtual void	SetSourceTextures (ITextureTable *value)=0

virtual void	SetUseMultisampling (bool UseMultisampling)=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 IDisplacementCaster *	SafeCast (IObject *ptr)

Static Public Member Functions inherited from SimplygonSDK::IMaterialCaster
static bool	IsClassA (const char *type)

static IMaterialCaster *	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

IDisplacementCaster is used to store the delta-values between the original and processed geometries. The values are divided by a scaling value, and clamped into the -1 -> 1 range before being stored into an image.

Definition at line 10383 of file SimplygonSDK.h.

Member Function Documentation

◆ GetClass()

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

◆ GetDisplacementCasterSettings()

virtual CountedPointer<IDisplacementCasterSettings> SimplygonSDK::IDisplacementCaster::GetDisplacementCasterSettings ( )

pure virtual

Get the displacement caster settings object

Returns: Displacement caster settings object

◆ GetDistanceScaling()

virtual real SimplygonSDK::IDisplacementCaster::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::IDisplacementCaster::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::IDisplacementCaster::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::IDisplacementCaster::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::IDisplacementCaster::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::IMaterialCaster.

◆ IsClassA()

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

inlinestatic

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

◆ SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IDisplacementCaster pointer

Returns: a pointer to the IDisplacementCaster object, if the cast can be made, and a NULL pointer otherwise

Definition at line 10417 of file SimplygonSDK.h.

◆ SetDistanceScaling()

virtual void SimplygonSDK::IDisplacementCaster::SetDistanceScaling ( real DistanceScaling )

pure virtual

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

Parameters

DistanceScaling the scale factor

◆ SetGenerateScalarDisplacement()

virtual void SimplygonSDK::IDisplacementCaster::SetGenerateScalarDisplacement ( bool GenerateScalarDisplacement )

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

GenerateScalarDisplacement the desired value

◆ SetGenerateTangentSpaceDisplacement()

virtual void SimplygonSDK::IDisplacementCaster::SetGenerateTangentSpaceDisplacement ( bool GenerateTangentSpaceDisplacement )

pure virtual

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

Parameters

GenerateTangentSpaceDisplacement the desired value

◆ SetNormalMapTextureLevel()

virtual void SimplygonSDK::IDisplacementCaster::SetNormalMapTextureLevel ( rid NormalMapTextureLevel )

pure virtual

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

Parameters

NormalMapTextureLevel the TexCoord level index to use

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

SimplygonSDK.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetClass()

◆ GetDisplacementCasterSettings()

◆ GetDistanceScaling()

◆ GetGenerateScalarDisplacement()

◆ GetGenerateTangentSpaceDisplacement()

◆ GetNormalMapTextureLevel()

◆ IsA()

◆ IsClassA()

◆ SafeCast()

◆ SetDistanceScaling()

◆ SetGenerateScalarDisplacement()

◆ SetGenerateTangentSpaceDisplacement()

◆ SetNormalMapTextureLevel()