Simplygon C++ API  8.3.35800.0
Public Member Functions | Static Public Member Functions | List of all members
SimplygonSDK::IOpacityCaster Class Referenceabstract

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IOpacityCaster:
SimplygonSDK::IMaterialCaster SimplygonSDK::IProcessingObject SimplygonSDK::IObject

Public Member Functions

virtual const char * GetClass ()
 
virtual rstring GetColorType ()=0
 
virtual CountedPointer< IOpacityCasterSettings > GetOpacityCasterSettings ()=0
 
virtual bool GetOutputSRGB ()=0
 
virtual bool IsA (const char *type) const
 
virtual void SetColorType (const char *ColorType)=0
 
virtual void SetOutputSRGB (bool OutputSRGB)=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 IOpacityCaster * 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

IOpacityCaster is the interface used to cast opacity values. To be used when opacity is needed as a separate texture.

Definition at line 9721 of file SimplygonSDK.h.

Member Function Documentation

◆ GetClass()

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

◆ GetColorType()

virtual rstring SimplygonSDK::IOpacityCaster::GetColorType ( )
pure virtual

Get which opacity channel to cast. The default value is SG_MATERIAL_CHANNEL_OPACITY.

Returns
the desired normals channel

◆ GetOpacityCasterSettings()

virtual CountedPointer<IOpacityCasterSettings> SimplygonSDK::IOpacityCaster::GetOpacityCasterSettings ( )
pure virtual

Get the opacity caster settings object

Returns
Opacity caster settings object

◆ GetOutputSRGB()

virtual bool SimplygonSDK::IOpacityCaster::GetOutputSRGB ( )
pure virtual

Get the OutputSRGB flag. If set, output textures are exported in SRGB format. Input texture format is determined by the flag in the corresponding texture node in the material definition. Default is true.

Returns
the current IsSRGB flag

◆ IsA()

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

The IsClassA function returns true if IOpacityCaster is a or is a descendant of the class named as the type parameter

Parameters
typeis 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 9742 of file SimplygonSDK.h.

◆ SafeCast()

static IOpacityCaster* SimplygonSDK::IOpacityCaster::SafeCast ( IObject *  ptr)
inlinestatic

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

Parameters
ptris the pointer to be cast into a IOpacityCaster pointer
Returns
a pointer to the IOpacityCaster object, if the cast can be made, and a NULL pointer otherwise

Definition at line 9755 of file SimplygonSDK.h.

◆ SetColorType()

virtual void SimplygonSDK::IOpacityCaster::SetColorType ( const char *  ColorType)
pure virtual

Set which opacity channel to cast. The default value is SG_MATERIAL_CHANNEL_OPACITY.

Parameters
ColorTypethe material channel name

◆ SetOutputSRGB()

virtual void SimplygonSDK::IOpacityCaster::SetOutputSRGB ( bool  OutputSRGB)
pure virtual

Set the OutputSRGB flag. If set, output textures are exported in SRGB format. Input texture format is determined by the flag in the corresponding texture node in the material definition. Default is true.

Parameters
OutputSRGBthe desired flag value
The documentation for this class was generated from the following file: