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

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IImpostorSettings:
SimplygonSDK::ISettingsObject SimplygonSDK::IObject

Public Member Functions

virtual const char * GetClass ()
 
virtual real GetTexCoordPadding ()=0
 
virtual real GetTightFittingDepthOffset ()=0
 
virtual bool GetTwoSided ()=0
 
virtual bool GetUseTightFitting ()=0
 
virtual void GetViewDirection (real *realReturnDataPtr)=0
 
virtual bool IsA (const char *type) const
 
virtual void SetTexCoordPadding (real value)=0
 
virtual void SetTightFittingDepthOffset (real value)=0
 
virtual void SetTwoSided (bool value)=0
 
virtual void SetUseTightFitting (bool value)=0
 
virtual void SetViewDirection (const real *value_realInputDataPtr)=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 IImpostorSettings * 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

Settings for the ImpostorProccessor

Definition at line 19395 of file SimplygonSDK.h.

Member Function Documentation

◆ GetClass()

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

◆ GetTexCoordPadding()

virtual real SimplygonSDK::IImpostorSettings::GetTexCoordPadding ( )
pure virtual

Set the TexCoord padding. Normally, the processor will generate an impostor with texcoords from 0.0 to 1.0, giving perfect UV coverage in the final texture. If your engine uses permanent tiling rendering mode, you may need to add a small padding to avoid sub-pixel wrapping artifact at the impostor edges, which this setting supplies. Ex: Setting this to 0.01 will generate texcoords in the range 0.01 to 0.99.

Returns
the current value of TexCoordPadding

◆ GetTightFittingDepthOffset()

virtual real SimplygonSDK::IImpostorSettings::GetTightFittingDepthOffset ( )
pure virtual

Get the depth offset. This determines where the impostor will end up in depth. 0 is "center", 1 is "front" and -1 is "back"

Returns
the current value of OnScreenSize

◆ GetTwoSided()

virtual bool SimplygonSDK::IImpostorSettings::GetTwoSided ( )
pure virtual

Set the TwoSided flag. If set, the impostor will contain both front and back facing surfaces.

Returns
the current value of TwoSided

◆ GetUseTightFitting()

virtual bool SimplygonSDK::IImpostorSettings::GetUseTightFitting ( )
pure virtual

Get the UseTightFitting flag. If set, the impostor will exactly conform to the bounds of the geometry. If false, its dimensions will always be diameter*diameter

Returns
the current value of UseTightFitting

◆ GetViewDirection()

virtual void SimplygonSDK::IImpostorSettings::GetViewDirection ( real *  realReturnDataPtr)
pure virtual

Get the view direction. This vector determines how the resulting impostor geometry will be oriented. The billboard will be perpendicular to this vector.

Parameters
realReturnDataPtrpointer to a user-provided data area to receive the return value. Note! Needs to be at least 3 elements in size
Returns
the current view vector

◆ IsA()

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

◆ IsClassA()

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

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

◆ SafeCast()

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

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

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

Definition at line 19429 of file SimplygonSDK.h.

◆ SetTexCoordPadding()

virtual void SimplygonSDK::IImpostorSettings::SetTexCoordPadding ( real  value)
pure virtual

Set the TexCoord padding. Normally, the processor will generate an impostor with texcoords from 0.0 to 1.0, giving perfect UV coverage in the final texture. If your engine uses permanent tiling rendering mode, you may need to add a small padding to avoid sub-pixel wrapping artifact at the impostor edges, which this setting supplies. Ex: Setting this to 0.01 will generate texcoords in the range 0.01 to 0.99.

Parameters
valueis the value TexCoordPadding will be set to

◆ SetTightFittingDepthOffset()

virtual void SimplygonSDK::IImpostorSettings::SetTightFittingDepthOffset ( real  value)
pure virtual

Set the depth offset. This determines where the impostor will end up in depth. 0 is "center", 1 is "front" and -1 is "back"

Parameters
valueis the value OnScreenSize will be set to

◆ SetTwoSided()

virtual void SimplygonSDK::IImpostorSettings::SetTwoSided ( bool  value)
pure virtual

Set the TwoSided flag. If set, the impostor will contain both front and back facing surfaces.

Parameters
valuethe new TwoSided value

◆ SetUseTightFitting()

virtual void SimplygonSDK::IImpostorSettings::SetUseTightFitting ( bool  value)
pure virtual

Set the UseTightFitting flag. If set, the impostor will exactly conform to the bounds of the geometry. If false, its dimensions will always be diameter*diameter

Parameters
valueis the value UseTightFitting will be set to

◆ SetViewDirection()

virtual void SimplygonSDK::IImpostorSettings::SetViewDirection ( const real *  value_realInputDataPtr)
pure virtual

Set the view direction. This vector determines how the resulting impostor geometry will be oriented. The billboard will be perpendicular to this vector.

Parameters
value_realInputDataPtris the new view vector
The documentation for this class was generated from the following file: