Simplygon 10 Documentation

# class GeometryCullingSettings

Settings for volumetric triangle culling functionality. These settings control the clipping planes and geometries that are used for triangle culling the output of Simplygon scene processors.

# Properties

Property Description
ClippingGeometrySelectionSetID Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set.
ClippingGeometrySelectionSetName Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set.
ClippingPlaneSelectionSetID Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set.
ClippingPlaneSelectionSetName Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set.
Name The name of the GeometryCullingSettings object. (Inherited from Object)
UseClippingGeometry If set, the geometries defined in the matching selection set will be used to clip the process geometry. What side of the geometry that will be culled is determined by the triangle facing, so make sure your winding is correct and that triangles point "up" toward the space you want to keep. Inconsistent triangle winding or meshes that do not have a clear local inside and outside will cause inconsistent results when used as clipping geometries.
UseClippingPlanes If true the ScenePlanes in the input scene (or the planes selected by the selection set settings) will be used to clip the mesh.

# Methods

Method Description
AddObserver Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetBoolParameter Get a named parameter boolean value. (Inherited from SettingsObject)
GetClass Get the name of the GeometryCullingSettings class. (Inherited from Object)
GetDoubleParameter Get a named parameter floating point value. (Inherited from SettingsObject)
GetErrorString Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject)
GetIntParameter Get a named parameter integer value. (Inherited from SettingsObject)
GetStringParameter Get a named parameter string value. (Inherited from SettingsObject)
GetUIntParameter Get a named parameter unsigned integer value. (Inherited from SettingsObject)
IsA Returns true if GeometryCullingSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the GeometryCullingSettings object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the GeometryCullingSettings object is valid. (Inherited from Object)
NonNull Returns true if the GeometryCullingSettings object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the GeometryCullingSettings object to the log. (Inherited from Object)
RemoveObserver Removes a previously added observer object. (Inherited from Object)
SetBoolParameter Set a named parameter boolean value. (Inherited from SettingsObject)
SetDoubleParameter Set a named parameter floating point value. (Inherited from SettingsObject)
SetIntParameter Set a named parameter integer value. (Inherited from SettingsObject)
SetStringParameter Set a named parameter string value. (Inherited from SettingsObject)
SetUIntParameter Set a named parameter unsigned integer value. (Inherited from SettingsObject)
SetValidateParameterNames Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled. (Inherited from SettingsObject)
ToJSON Get settings as JSON for debugging purposes. (Inherited from SettingsObject)
ValidateSettings Validates the current settings values. (Inherited from SettingsObject)

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast SafeCast makes sure the input object is of a class that can be cast into spGeometryCullingSettings, and if this is the case, returns the object cast into spGeometryCullingSettings. (Inherited from Object)

# Properties details

# ClippingGeometrySelectionSetID

Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set.

# Syntax

// Setter
void SetClippingGeometrySelectionSetID( rid value ) const;

// Getter
rid GetClippingGeometrySelectionSetID() const;

# SetClippingGeometrySelectionSetID parameters

Type Name Min Max Description
rid value -1 The desired SelectionSet id.

# GetClippingGeometrySelectionSetID return value

Type: rid

Default: -1

# ClippingGeometrySelectionSetName

Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set.

# Syntax

// Setter
void SetClippingGeometrySelectionSetName( const char * value ) const;

// Getter
spString GetClippingGeometrySelectionSetName() const;

# SetClippingGeometrySelectionSetName parameters

Type Name Min Max Description
const char * value The desired SelectionSet name.

# GetClippingGeometrySelectionSetName return value

Type: spString

Default: nullptr

# ClippingPlaneSelectionSetID

Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set.

# Syntax

// Setter
void SetClippingPlaneSelectionSetID( rid value ) const;

// Getter
rid GetClippingPlaneSelectionSetID() const;

# SetClippingPlaneSelectionSetID parameters

Type Name Min Max Description
rid value -1 The desired SelectionSet id.

# GetClippingPlaneSelectionSetID return value

Type: rid

Default: -1

# ClippingPlaneSelectionSetName

Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set.

# Syntax

// Setter
void SetClippingPlaneSelectionSetName( const char * value ) const;

// Getter
spString GetClippingPlaneSelectionSetName() const;

# SetClippingPlaneSelectionSetName parameters

Type Name Min Max Description
const char * value The desired SelectionSet name.

# GetClippingPlaneSelectionSetName return value

Type: spString

Default: nullptr

# Name

The name of the GeometryCullingSettings object. (Inherited from Object)

# Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

# SetName parameters

Type Name Min Max Description
const char * name New name of the object.

# GetName return value

Type: spString

# UseClippingGeometry

If set, the geometries defined in the matching selection set will be used to clip the process geometry. What side of the geometry that will be culled is determined by the triangle facing, so make sure your winding is correct and that triangles point "up" toward the space you want to keep. Inconsistent triangle winding or meshes that do not have a clear local inside and outside will cause inconsistent results when used as clipping geometries.

# Syntax

// Setter
void SetUseClippingGeometry( bool value ) const;

// Getter
bool GetUseClippingGeometry() const;

# SetUseClippingGeometry parameters

Type Name Min Max Description
bool value The bool UseClippingGeometry will be set to.

# GetUseClippingGeometry return value

Type: bool

Default: false

# UseClippingPlanes

If true the ScenePlanes in the input scene (or the planes selected by the selection set settings) will be used to clip the mesh.

# Syntax

// Setter
void SetUseClippingPlanes( bool value ) const;

// Getter
bool GetUseClippingPlanes() const;

# SetUseClippingPlanes parameters

Type Name Min Max Description
bool value The bool UseClippingPlanes will be set to.

# GetUseClippingPlanes return value

Type: bool

Default: false

# Methods details

# AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

# Syntax

rid AddObserver( const spObserver & observer ) const;

# Parameters

Type Name Min Max Description
Observer observer Observer is the object that will receive events.

# Return value

Type: rid

# GetBoolParameter

Get a named parameter boolean value.

# Syntax

bool GetBoolParameter( const char * name ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.

# Return value

Type: bool

# GetClass

Get the name of the GeometryCullingSettings class. (Inherited from Object)

# Syntax

spString GetClass() const;

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetDoubleParameter

Get a named parameter floating point value.

# Syntax

double GetDoubleParameter( const char * name ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.

# Return value

Type: double

# GetErrorString

Returns a string describing the error that was found the last time ValidateSettings was performed.

# Syntax

spString GetErrorString() const;

# Parameters

GetErrorString takes no parameters.

# Return value

Type: spString

# GetIntParameter

Get a named parameter integer value.

# Syntax

int GetIntParameter( const char * name ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.

# Return value

Type: int

# GetStringParameter

Get a named parameter string value.

# Syntax

spString GetStringParameter( const char * name ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.

# Return value

Type: spString

# GetUIntParameter

Get a named parameter unsigned integer value.

# Syntax

unsigned int GetUIntParameter( const char * name ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.

# Return value

Type: unsigned int

# IsA

Returns true if GeometryCullingSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# Syntax

bool IsA( const char * type ) const;

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if GeometryCullingSettings is, or is a descendant of.

# Return value

Type: bool

# IsNull

Returns true if the GeometryCullingSettings object is invalid. (Inherited from Object)

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

Returns true if the GeometryCullingSettings object is valid. (Inherited from Object)

# Syntax

bool IsSameObjectAs( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to compare with.

# Return value

Type: bool

# NonNull

Returns true if the GeometryCullingSettings object is valid. (Inherited from Object)

# Syntax

bool NonNull() const;

# Parameters

NonNull takes no parameters.

# Return value

Type: bool

# PrintInfo

Prints the content/info of the GeometryCullingSettings object to the log. (Inherited from Object)

# Syntax

void PrintInfo() const;

# Parameters

PrintInfo takes no parameters.

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

# Syntax

void RemoveObserver( rid observerId ) const;

# Parameters

Type Name Min Max Description
rid observerId ObserverId is the id returned by AddObserver when the observer was added.

# SetBoolParameter

Set a named parameter boolean value.

# Syntax

bool SetBoolParameter( const char * name , bool value ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.
bool value New value for parameter.

# Return value

Type: bool

# SetDoubleParameter

Set a named parameter floating point value.

# Syntax

bool SetDoubleParameter( const char * name , double value ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.
double value New value for parameter.

# Return value

Type: bool

# SetIntParameter

Set a named parameter integer value.

# Syntax

bool SetIntParameter( const char * name , int value ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.
int value New value for parameter.

# Return value

Type: bool

# SetStringParameter

Set a named parameter string value.

# Syntax

bool SetStringParameter( const char * name , const char * value ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.
const char * value New value for parameter.

# Return value

Type: bool

# SetUIntParameter

Set a named parameter unsigned integer value.

# Syntax

bool SetUIntParameter( const char * name , unsigned int value ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.
unsigned int value New value for parameter.

# Return value

Type: bool

# SetValidateParameterNames

Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled.

# Syntax

void SetValidateParameterNames( bool validate ) const;

# Parameters

Type Name Min Max Description
bool validate Flag indicating if validation is performed or not.

# ToJSON

Get settings as JSON for debugging purposes.

# Syntax

spString ToJSON() const;

# Parameters

ToJSON takes no parameters.

# Return value

Type: spString

# ValidateSettings

Validates the current settings values.

# Syntax

bool ValidateSettings() const;

# Parameters

ValidateSettings takes no parameters.

# Return value

Type: bool

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# Syntax

static bool IsClassA( const char * type ) const;

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if the class is, or is a descendant of.

# Return value

Type: bool

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spGeometryCullingSettings, and if this is the case, returns the object cast into spGeometryCullingSettings. (Inherited from Object)

# Syntax

static spGeometryCullingSettings SafeCast( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: GeometryCullingSettings

← GeometryDataCasterSettings →

Terms of Use | Privacy & Cookies | Trademarks
Copyright © 2022 Microsoft