#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IOcclusionMeshSettings:

Public Member Functions
virtual int	GetCameraSelectionSetId ()=0

virtual rstring	GetCameraSelectionSetName ()=0

virtual const char *	GetClass ()

virtual bool	GetInvertOutputMesh ()=0

virtual unsigned int	GetOcclusionMode ()=0

virtual unsigned int	GetOnScreenErrorTolerance ()=0

virtual unsigned int	GetOnScreenSize ()=0

virtual bool	GetTransferSkinning ()=0

virtual bool	GetUseCameras ()=0

virtual bool	IsA (const char *type) const

virtual void	SetCameraSelectionSetId (int value)=0

virtual void	SetCameraSelectionSetName (const char *value)=0

virtual void	SetInvertOutputMesh (bool value)=0

virtual void	SetOcclusionMode (unsigned int value)=0

virtual void	SetOnScreenErrorTolerance (unsigned int value)=0

virtual void	SetOnScreenSize (unsigned int value)=0

virtual void	SetTransferSkinning (bool value)=0

virtual void	SetUseCameras (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 IOcclusionMeshSettings *	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 occlusion meshes

Definition at line 19827 of file SimplygonSDK.h.

Member Function Documentation

◆ GetCameraSelectionSetId()

virtual int SimplygonSDK::IOcclusionMeshSettings::GetCameraSelectionSetId ( )

pure virtual

Set the camera selection set id. This determines the selection set used for the cameras for when UseCameras is on. A value of -1 uses all cameras in the scene.

Returns: the current CameraSelectionSetId

◆ GetCameraSelectionSetName()

virtual rstring SimplygonSDK::IOcclusionMeshSettings::GetCameraSelectionSetName ( )

pure virtual

Get the camera selection set id. This determines the selection set used for the cameras for when UseCameras is on. If set to NULL, all cameras in the scene will be processed. If both ID and Name are set, ID will be used.

Returns: the current SelectionSet name

◆ GetClass()

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

◆ GetInvertOutputMesh()

virtual bool SimplygonSDK::IOcclusionMeshSettings::GetInvertOutputMesh ( )

pure virtual

Flips the winding of the triangles of the output, making frontfaces backfaces and vice versa. Good for conservative z testing.

Returns: the current value of InvertOutputMesh

◆ GetOcclusionMode()

virtual unsigned int SimplygonSDK::IOcclusionMeshSettings::GetOcclusionMode ( )

pure virtual

Get the occlusion mode. This decides if the processor generates an occluder (which is smaller than the original mesh), an ocludee (which is larger), or an output that just tries to match the input. The options are: SG_OCCLUSIONMODE_OCCLUDER, SG_OCCLUSIONMODE_OCLUDEE or SG_OCCLUSIONMODE_STANDARD

Returns: the current OcclusionMode

◆ GetOnScreenErrorTolerance()

virtual unsigned int SimplygonSDK::IOcclusionMeshSettings::GetOnScreenErrorTolerance ( )

pure virtual

Get the OnScreenErrorTolerance. This determines how large of an error that is tolerated, in pixels. Valid range is 1-50. Since this setting is based around the absolute worst-case scenario, you can usually get good results at relatively high tolerances.

Returns: the current OnScreenErrorTolerance

◆ GetOnScreenSize()

virtual unsigned int SimplygonSDK::IOcclusionMeshSettings::GetOnScreenSize ( )

pure virtual

Get the the onscreen size (px) of the output utility mesh. This will determine triangle count and quality.

Returns: the current onscreen size

◆ GetTransferSkinning()

virtual bool SimplygonSDK::IOcclusionMeshSettings::GetTransferSkinning ( )

pure virtual

Gets whether to transfer the bone weights and bone ids to the new geometry

Returns: the current value of InvertOutputMesh

◆ GetUseCameras()

virtual bool SimplygonSDK::IOcclusionMeshSettings::GetUseCameras ( )

pure virtual

Gets UseCameras. If set, cameras from the input scene will be used to define what angles the occlusion mesh can be visible from, and optimize the output mesh accordingly. Otherwise, the occlusion mesh will be assumed to be viewable from all directions.

Returns: the current value of UseCameras

◆ IsA()

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

◆ IsClassA()

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

inlinestatic

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

◆ SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IOcclusionMeshSettings pointer

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

Definition at line 19861 of file SimplygonSDK.h.

◆ SetCameraSelectionSetId()

virtual void SimplygonSDK::IOcclusionMeshSettings::SetCameraSelectionSetId ( int value )

pure virtual

Get the camera selection set id. This determines the selection set used for the cameras for when UseCameras is on. A value of -1 uses all cameras in the scene.

Parameters

value the desired OcclusionMode

◆ SetCameraSelectionSetName()

virtual void SimplygonSDK::IOcclusionMeshSettings::SetCameraSelectionSetName ( const char * value )

pure virtual

Set the camera selection set name. This determines the selection set used for the cameras for when UseCameras is on. If set to NULL, all cameras in the scene will be used. If both ID and Name are set, ID will be used.

Parameters

value the desired SelectionSet name

◆ SetInvertOutputMesh()

virtual void SimplygonSDK::IOcclusionMeshSettings::SetInvertOutputMesh ( bool value )

pure virtual

Flips the winding of the triangles of the output, making frontfaces backfaces and vice versa. Good for conservative z testing.

Parameters

value the desired value of InvertOutputMesh

◆ SetOcclusionMode()

virtual void SimplygonSDK::IOcclusionMeshSettings::SetOcclusionMode ( unsigned int value )

pure virtual

Set the occlusion mode. This decides if the processor generates an occluder (which is smaller than the original mesh), an ocludee (which is larger), or an output that just tries to match the input. The options are: SG_OCCLUSIONMODE_OCCLUDER, SG_OCCLUSIONMODE_OCLUDEE or SG_OCCLUSIONMODE_STANDARD

Parameters

value the desired OcclusionMode

◆ SetOnScreenErrorTolerance()

virtual void SimplygonSDK::IOcclusionMeshSettings::SetOnScreenErrorTolerance ( unsigned int value )

pure virtual

Set the OnScreenErrorTolerance. This determines how large of an error that is tolerated, in pixels. Valid range is 1-50. Since this setting is based around the absolute worst-case scenario, you can usually get good results at relatively high tolerances.

Parameters

value the desired OnScreenErrorTolerance

◆ SetOnScreenSize()

virtual void SimplygonSDK::IOcclusionMeshSettings::SetOnScreenSize ( unsigned int value )

pure virtual

Set the onscreen size (px) of the output utility mesh. This will determine triangle count and quality.

Parameters

value the desired onscreen size

◆ SetTransferSkinning()

virtual void SimplygonSDK::IOcclusionMeshSettings::SetTransferSkinning ( bool value )

pure virtual

Sets whether to transfer the bone weights and bone ids to the new geometry

Parameters

value the desired value of InvertOutputMesh

◆ SetUseCameras()

virtual void SimplygonSDK::IOcclusionMeshSettings::SetUseCameras ( bool value )

pure virtual

Sets UseCameras. If set, cameras from the input scene will be used to define what angles the occlusion mesh can be visible from, and optimize the output mesh accordingly. Otherwise, the occlusion mesh will be assumed to be viewable from all directions.

Parameters

value the desired value of UseCameras

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

◆ GetCameraSelectionSetId()

◆ GetCameraSelectionSetName()

◆ GetClass()

◆ GetInvertOutputMesh()

◆ GetOcclusionMode()

◆ GetOnScreenErrorTolerance()

◆ GetOnScreenSize()

◆ GetTransferSkinning()

◆ GetUseCameras()

◆ IsA()

◆ IsClassA()

◆ SafeCast()

◆ SetCameraSelectionSetId()

◆ SetCameraSelectionSetName()

◆ SetInvertOutputMesh()

◆ SetOcclusionMode()

◆ SetOnScreenErrorTolerance()

◆ SetOnScreenSize()

◆ SetTransferSkinning()

◆ SetUseCameras()