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

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::INormalCasterSettings:
SimplygonSDK::IMaterialCasterSettings SimplygonSDK::ISettingsObject SimplygonSDK::IObject

Public Member Functions

virtual const char * GetClass ()
 
virtual bool GetFlipBackfacingNormals ()=0
 
virtual bool GetFlipGreen ()=0
 
virtual bool GetGenerateTangentSpaceNormals ()=0
 
virtual bool IsA (const char *type) const
 
virtual void SetFlipBackfacingNormals (bool value)=0
 
virtual void SetFlipGreen (bool value)=0
 
virtual void SetGenerateTangentSpaceNormals (bool 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 INormalCasterSettings * 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

INormalCasterSettings is the interface used to manage settings for a normal caster

Definition at line 10006 of file SimplygonSDK.h.

Member Function Documentation

◆ GetClass()

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

◆ GetFlipBackfacingNormals()

virtual bool SimplygonSDK::INormalCasterSettings::GetFlipBackfacingNormals ( )
pure virtual

Get the FlipBackfacingNormals flag. If set, then normals will be flipped if they are back facing, i.e., pointing into the surface. This may introduce artifacts on geometries that have correctly facing normals, so only use for geometries with known back-facing normals.

Returns
the current value of the FlipBackfacingNormals bool

◆ GetFlipGreen()

virtual bool SimplygonSDK::INormalCasterSettings::GetFlipGreen ( )
pure virtual

Get the FlipGreen flag. If set, the green channel is assumed to point along the negative bitangent instead of the positive.

Returns
the current value of the FlipGreen bool

◆ GetGenerateTangentSpaceNormals()

virtual bool SimplygonSDK::INormalCasterSettings::GetGenerateTangentSpaceNormals ( )
pure virtual

Get the GenerateTangentSpaceNormals flag. If set, then the generated normal map will be in tangent space. Please note that the geometry casted to must contain tangent space fields.

Returns
the current value of the GenerateTangentSpaceNormals bool

◆ IsA()

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

◆ IsClassA()

static bool SimplygonSDK::INormalCasterSettings::IsClassA ( const char *  type)
inlinestatic

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

◆ SafeCast()

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

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

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

Definition at line 10040 of file SimplygonSDK.h.

◆ SetFlipBackfacingNormals()

virtual void SimplygonSDK::INormalCasterSettings::SetFlipBackfacingNormals ( bool  value)
pure virtual

Set the FlipBackfacingNormals flag. If set, then normals will be flipped if they are back facing, i.e., pointing into the surface. This may introduce artifacts on geometries that have correctly facing normals, so only use for geometries with known back-facing normals.

Parameters
valueis the value to which the FlipBackfacingNormals bool is to be set

◆ SetFlipGreen()

virtual void SimplygonSDK::INormalCasterSettings::SetFlipGreen ( bool  value)
pure virtual

Set the FlipGreen flag. If set, the green channel is assumed to point along the negative bitangent instead of the positive.

Parameters
valueis the value the FlipGreen bool is to be set

◆ SetGenerateTangentSpaceNormals()

virtual void SimplygonSDK::INormalCasterSettings::SetGenerateTangentSpaceNormals ( bool  value)
pure virtual

Set the GenerateTangentSpaceNormals flag. If set, then the generated normal map will be in tangent space. Please note that the geometry casted to must contain tangent space fields.

Parameters
valueis the value to which the GenerateTangentSpaceNormals bool is to be set
The documentation for this class was generated from the following file: