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

#include <SimplygonSDK.h>

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

Public Member Functions

virtual const char * GetClass ()
 
virtual real GetOcclusionFalloff ()=0
 
virtual real GetOcclusionMultiplier ()=0
 
virtual unsigned int GetRaysPerPixel ()=0
 
virtual bool GetUseSimpleOcclusionMode ()=0
 
virtual bool IsA (const char *type) const
 
virtual void SetOcclusionFalloff (real value)=0
 
virtual void SetOcclusionMultiplier (real value)=0
 
virtual void SetRaysPerPixel (unsigned int value)=0
 
virtual void SetUseSimpleOcclusionMode (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 IAmbientOcclusionCasterSettings * 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

IAmbientOcclusionCasterSettings manages settings for an ambient occlusion caster

Definition at line 19172 of file SimplygonSDK.h.

Member Function Documentation

◆ GetClass()

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

◆ GetOcclusionFalloff()

virtual real SimplygonSDK::IAmbientOcclusionCasterSettings::GetOcclusionFalloff ( )
pure virtual

Get the occlusion falloff, ie. how far away a surface has to be from another surface to generate no occlusion. Only applicable if SimpleOcclusionMode is off.

Returns
the occlusion falloff

◆ GetOcclusionMultiplier()

virtual real SimplygonSDK::IAmbientOcclusionCasterSettings::GetOcclusionMultiplier ( )
pure virtual

Get the occlusion multiplier. This is just a basic intensity scaler. Higher is "darker".

Returns
the occlusion multiplier

◆ GetRaysPerPixel()

virtual unsigned int SimplygonSDK::IAmbientOcclusionCasterSettings::GetRaysPerPixel ( )
pure virtual

Get the rays per pixel. This determines how many rays are traced per pixel (or subpixel) to evaluate the occlusion.

Returns
the number of rays

◆ GetUseSimpleOcclusionMode()

virtual bool SimplygonSDK::IAmbientOcclusionCasterSettings::GetUseSimpleOcclusionMode ( )
pure virtual

Get the SimpleOcclusionMode flag. If set, occlusion will not scale with distance, each ray will only be either fully occluded or not at all. Speeds up processing time.

Returns
the current value of UseSimpleOcclusionMode

◆ IsA()

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

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

◆ SafeCast()

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

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

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

Definition at line 19206 of file SimplygonSDK.h.

◆ SetOcclusionFalloff()

virtual void SimplygonSDK::IAmbientOcclusionCasterSettings::SetOcclusionFalloff ( real  value)
pure virtual

Set the occlusion falloff, ie. how far away a surface has to be from another surface to generate no occlusion. Only applicable if SimpleOcclusionMode is off.

Parameters
valuethe far occlusion falloff

◆ SetOcclusionMultiplier()

virtual void SimplygonSDK::IAmbientOcclusionCasterSettings::SetOcclusionMultiplier ( real  value)
pure virtual

Set the occlusion multiplier. This is just a basic intensity scaler. Higher is "darker".

Parameters
valuethe occlusion multiplier

◆ SetRaysPerPixel()

virtual void SimplygonSDK::IAmbientOcclusionCasterSettings::SetRaysPerPixel ( unsigned int  value)
pure virtual

Set the rays per pixel. This determines how many rays are traced per pixel (or subpixel) to evaluate the occlusion.

Parameters
valuethe desired number of rays

◆ SetUseSimpleOcclusionMode()

virtual void SimplygonSDK::IAmbientOcclusionCasterSettings::SetUseSimpleOcclusionMode ( bool  value)
pure virtual

Set the SimpleOcclusionMode flag. If set, occlusion will not scale with distance, each ray will only be either fully occluded or not at all. Speeds up processing time.

Parameters
valuethe flag to which UseSimpleOcclusionMode will be set
The documentation for this class was generated from the following file: