#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IMaterialCasterSettings:

Public Member Functions
virtual const char *	GetClass ()

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 bool	IsA (const char *type) const

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 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

IMaterialCasterSettings is the base interface for material casting settings

Definition at line 9325 of file SimplygonSDK.h.

Member Function Documentation

◆ GetClass()

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

Reimplemented in SimplygonSDK::IAmbientOcclusionCasterSettings, SimplygonSDK::IDisplacementCasterSettings, SimplygonSDK::INormalCasterSettings, SimplygonSDK::IOpacityCasterSettings, and SimplygonSDK::IColorCasterSettings.

◆ GetDilation()

virtual unsigned int SimplygonSDK::IMaterialCasterSettings::GetDilation ( )

pure virtual

Get the Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels.

Returns: the Dilation value

◆ GetDitherType()

virtual unsigned int SimplygonSDK::IMaterialCasterSettings::GetDitherType ( )

pure virtual

The type of dithering to use when creating the output object. Use the DitherPattern enum to choose. Default is SG_DITHERPATTERNS_NO_DITHER.

◆ GetFillMode()

virtual int SimplygonSDK::IMaterialCasterSettings::GetFillMode ( )

pure virtual

The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed.

Returns: Fill mode value

◆ GetMaterialChannel()

virtual rstring SimplygonSDK::IMaterialCasterSettings::GetMaterialChannel ( )

pure virtual

Get which material channel to cast. The material channels are defined as SG_MATERIAL_CHANNEL_[ CHANNEL ]. For example, the diffuse channel is SG_MATERIAL_CHANNEL_DIFFUSE.

Returns: the current material channel.

◆ GetOutputChannelBitDepth()

virtual unsigned int SimplygonSDK::IMaterialCasterSettings::GetOutputChannelBitDepth ( )

pure virtual

Get the OutputBitDepth parameter. This can be either 8 or 16. Please note that this is the bit depth per-channel, so a bit depth of 8 and a OutputChannels value of 3 will result in 8*3 = 24-bit RGB values.

Returns: the OutputBitDepth value

◆ GetOutputChannels()

virtual unsigned int SimplygonSDK::IMaterialCasterSettings::GetOutputChannels ( )

pure virtual

Get the OutputChannels parameter.

Returns: the OutputChannels value

◆ GetUseMultisampling()

virtual bool SimplygonSDK::IMaterialCasterSettings::GetUseMultisampling ( )

pure virtual

Enable or disable multisampling

◆ IsA()

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

Reimplemented in SimplygonSDK::IAmbientOcclusionCasterSettings, SimplygonSDK::IDisplacementCasterSettings, SimplygonSDK::INormalCasterSettings, SimplygonSDK::IOpacityCasterSettings, and SimplygonSDK::IColorCasterSettings.

◆ IsClassA()

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

inlinestatic

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

◆ SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IMaterialCasterSettings pointer

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

Definition at line 9359 of file SimplygonSDK.h.

◆ SetDilation()

virtual void SimplygonSDK::IMaterialCasterSettings::SetDilation ( unsigned int value )

pure virtual

Set the Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels.

Parameters

value is the value to which Dilation will be set

◆ SetDitherType()

virtual void SimplygonSDK::IMaterialCasterSettings::SetDitherType ( unsigned int value )

pure virtual

The type of dithering to use when creating the output object. Use the DitherPattern enum to choose. Default is SG_DITHERPATTERNS_NO_DITHER.

0 (SG_DITHERPATTERNS_NO_DITHER)
1 (SG_DITHERPATTERNS_FLOYDSTEINBERG)
2 (SG_DITHERPATTERNS_JARVISJUDICENINKE)
3 (SG_DITHERPATTERNS_SIERRA)

Parameters

value is the value of the DitherType to use

◆ SetFillMode()

virtual void SimplygonSDK::IMaterialCasterSettings::SetFillMode ( int value )

pure virtual

The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed.
Options are:
SG_ATLASFILLMODE_NONE = Do not fill remaining pixels
SG_ATLASFILLMODE_INTERPOLATE = linearly interpolate the closest samples
SG_ATLASFILLMODE_NEARESTNEIGHBOR = use the closest available pixel value without interpolation

Parameters

value is the mode to which the fill mode will be set

◆ SetMaterialChannel()

virtual void SimplygonSDK::IMaterialCasterSettings::SetMaterialChannel ( const char * value )

pure virtual

Set which material channel to cast. The material channels are defined as SG_MATERIAL_CHANNEL_[ CHANNEL ]. For example, the diffuse channel is SG_MATERIAL_CHANNEL_DIFFUSE.

Parameters

value the desired material channel

◆ SetOutputChannelBitDepth()

virtual void SimplygonSDK::IMaterialCasterSettings::SetOutputChannelBitDepth ( unsigned int value )

pure virtual

Set the OutputBitDepth parameter. This can be either 8 or 16. Please note that this is the bit depth per-channel, so a bit depth of 8 and a OutputChannels value of 3 will result in 8*3 = 24-bit RGB values.

Parameters

value is the value to which OutputBitDepth will be set

◆ SetOutputChannels()

virtual void SimplygonSDK::IMaterialCasterSettings::SetOutputChannels ( unsigned int value )

pure virtual

Set the OutputChannels parameter. This can be set to either:

1 (Luminance)
3 (RGB)
4 (RGBA)

Parameters

value is the value to which OutputChannels will be set

◆ SetUseMultisampling()

virtual void SimplygonSDK::IMaterialCasterSettings::SetUseMultisampling ( bool value )

pure virtual

Enable or disable multisampling

Parameters

value the desired value of the flag

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()

◆ GetDilation()

◆ GetDitherType()

◆ GetFillMode()

◆ GetMaterialChannel()

◆ GetOutputChannelBitDepth()

◆ GetOutputChannels()

◆ GetUseMultisampling()

◆ IsA()

◆ IsClassA()

◆ SafeCast()

◆ SetDilation()

◆ SetDitherType()

◆ SetFillMode()

◆ SetMaterialChannel()

◆ SetOutputChannelBitDepth()

◆ SetOutputChannels()

◆ SetUseMultisampling()