class PartRemoverSettings

The PartRemoverSettings settings object for the PartRemover tool as well as Reduction pipeline and processor.

Properties

Property	Description
Name	The name of the PartRemoverSettings object. (Inherited from Object)
PartRemoverThresholdType	Determines which kind of size threshold will be used.
Threshold	The threshold value. How it is interpreted depends on the ThresholdType Enum.
UseSurfaceArea	If set, objects with small surface area but big diameter will also be removed.
UseVertexLocks	If set, objects containing locked vertices will not be removed.

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 PartRemoverSettings 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 PartRemoverSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the PartRemoverSettings object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the PartRemoverSettings object is valid. (Inherited from Object)
NonNull	Returns true if the PartRemoverSettings object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the PartRemoverSettings 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 spPartRemoverSettings, and if this is the case, returns the object cast into spPartRemoverSettings. (Inherited from Object)

Properties details

Name

The name of the PartRemoverSettings 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

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

Type	Name	Min	Max	Description
string	name			New name of the object.

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

Name	Type	Min	Max	Description
name	str			New name of the object.

GetName return value

Type: str

PartRemoverThresholdType

Determines which kind of size threshold will be used.

Syntax

// Setter
void SetPartRemoverThresholdType( Simplygon::EPartRemoverThresholdType value ) const;

// Getter
Simplygon::EPartRemoverThresholdType GetPartRemoverThresholdType() const;

SetPartRemoverThresholdType parameters

Type	Name	Min	Max	Description
EPartRemoverThresholdType	value			The value to set to.

GetPartRemoverThresholdType return value

Type: EPartRemoverThresholdType

Default: PhysicalSize

Key	Value	Comment
PhysicalSize	0	All objects with a diameter smaller than the actual world space size of the threshold will be removed.
OnScreenSize	1	All objects that are smaller than 1 pixel, when the scene is viewed at the selected OnScreenSize, will be removed.
PercentageOfSceneDiameter	2	All objects with a diameter smaller than the selected percentage of the scene diameter will be removed.

Syntax

// Setter
void SetPartRemoverThresholdType(EPartRemoverThresholdType value);

// Getter
EPartRemoverThresholdType GetPartRemoverThresholdType();

SetPartRemoverThresholdType parameters

Type	Name	Min	Max	Description
EPartRemoverThresholdType	value			The value to set to.

GetPartRemoverThresholdType return value

Type: EPartRemoverThresholdType

Default: PhysicalSize

Key	Value	Comment
PhysicalSize	0	All objects with a diameter smaller than the actual world space size of the threshold will be removed.
OnScreenSize	1	All objects that are smaller than 1 pixel, when the scene is viewed at the selected OnScreenSize, will be removed.
PercentageOfSceneDiameter	2	All objects with a diameter smaller than the selected percentage of the scene diameter will be removed.

Syntax

# Setter
None SetPartRemoverThresholdType(value: EPartRemoverThresholdType_*)

# Getter
EPartRemoverThresholdType_* GetPartRemoverThresholdType()

SetPartRemoverThresholdType parameters

Name	Type	Min	Max	Description
value	EPartRemoverThresholdType			The value to set to.

GetPartRemoverThresholdType return value

Type: EPartRemoverThresholdType

Default: PhysicalSize

Key	Value	Comment
EPartRemoverThresholdType_PhysicalSize	0	All objects with a diameter smaller than the actual world space size of the threshold will be removed.
EPartRemoverThresholdType_OnScreenSize	1	All objects that are smaller than 1 pixel, when the scene is viewed at the selected OnScreenSize, will be removed.
EPartRemoverThresholdType_PercentageOfSceneDiameter	2	All objects with a diameter smaller than the selected percentage of the scene diameter will be removed.

Threshold

The threshold value. How it is interpreted depends on the ThresholdType Enum.

Syntax

// Setter
void SetThreshold( real value ) const;

// Getter
real GetThreshold() const;

SetThreshold parameters

Type	Name	Min	Max	Description
real	value	0.0	REAL_MAX	The value to set to.

GetThreshold return value

Type: real

Default: 0.0

Syntax

// Setter
void SetThreshold(float value);

// Getter
float GetThreshold();

SetThreshold parameters

Type	Name	Min	Max	Description
float	value	0.0	REAL_MAX	The value to set to.

GetThreshold return value

Type: float

Default: 0.0

Syntax

# Setter
None SetThreshold(value: float)

# Getter
float GetThreshold()

SetThreshold parameters

Name	Type	Min	Max	Description
value	float	0.0	REAL_MAX	The value to set to.

GetThreshold return value

Type: float

Default: 0.0

UseSurfaceArea

If set, objects with small surface area but big diameter will also be removed.

Syntax

// Setter
void SetUseSurfaceArea( bool value ) const;

// Getter
bool GetUseSurfaceArea() const;

SetUseSurfaceArea parameters

Type	Name	Min	Max	Description
bool	value			The value to set to.

GetUseSurfaceArea return value

Type: bool

Default: false

Syntax

// Setter
void SetUseSurfaceArea(bool value);

// Getter
bool GetUseSurfaceArea();

SetUseSurfaceArea parameters

Type	Name	Min	Max	Description
bool	value			The value to set to.

GetUseSurfaceArea return value

Type: bool

Default: false

Syntax

# Setter
None SetUseSurfaceArea(value: bool)

# Getter
bool GetUseSurfaceArea()

SetUseSurfaceArea parameters

Name	Type	Min	Max	Description
value	bool			The value to set to.

GetUseSurfaceArea return value

Type: bool

Default: false

UseVertexLocks

If set, objects containing locked vertices will not be removed.

Syntax

// Setter
void SetUseVertexLocks( bool value ) const;

// Getter
bool GetUseVertexLocks() const;

SetUseVertexLocks parameters

Type	Name	Min	Max	Description
bool	value			The value to set to.

GetUseVertexLocks return value

Type: bool

Default: true

Syntax

// Setter
void SetUseVertexLocks(bool value);

// Getter
bool GetUseVertexLocks();

SetUseVertexLocks parameters

Type	Name	Min	Max	Description
bool	value			The value to set to.

GetUseVertexLocks return value

Type: bool

Default: true

Syntax

# Setter
None SetUseVertexLocks(value: bool)

# Getter
bool GetUseVertexLocks()

SetUseVertexLocks parameters

Name	Type	Min	Max	Description
value	bool			The value to set to.

GetUseVertexLocks return value

Type: bool

Default: true

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

Syntax

int AddObserver(spObserver observer);

Parameters

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

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

Parameters

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

Return value

Type: int

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

Syntax

bool GetBoolParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: bool

Syntax

bool GetBoolParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: bool

GetClass

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

Syntax

spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

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

Syntax

double GetDoubleParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: double

Syntax

float GetDoubleParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: float

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

Syntax

string GetErrorString();

Parameters

GetErrorString takes no parameters.

Return value

Type: string

Syntax

str GetErrorString()

Parameters

GetErrorString takes no parameters.

Return value

Type: str

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

Syntax

int GetIntParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: int

Syntax

int GetIntParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			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

Syntax

string GetStringParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: string

Syntax

str GetStringParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: str

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

Syntax

uint GetUIntParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: uint

Syntax

int GetUIntParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: int

IsA

Returns true if PartRemoverSettings 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 PartRemoverSettings is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(string type);

Parameters

Type	Name	Min	Max	Description
string	type			Name of the class to check if PartRemoverSettings is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			Name of the class to check if PartRemoverSettings is, or is a descendant of.

Return value

Type: bool

IsNull

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

Syntax

bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

Returns true if the PartRemoverSettings 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

Syntax

bool IsSameObjectAs(spObject object);

Parameters

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

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

Parameters

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

Return value

Type: bool

NonNull

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

Syntax

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

Parameters

NonNull takes no parameters.

Return value

Type: bool

PrintInfo

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

Syntax

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

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.

Syntax

void RemoveObserver(int observerId);

Parameters

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

Syntax

None RemoveObserver(observerId: int)

Parameters

Name	Type	Min	Max	Description
observerId	int			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

Syntax

bool SetBoolParameter(string name, bool value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
bool	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetBoolParameter(name: str, value: bool)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	bool			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

Syntax

bool SetDoubleParameter(string name, double value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
double	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetDoubleParameter(name: str, value: float)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	float			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

Syntax

bool SetIntParameter(string name, int value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
int	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetIntParameter(name: str, value: int)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	int			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

Syntax

bool SetStringParameter(string name, string value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
string	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetStringParameter(name: str, value: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	str			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

Syntax

bool SetUIntParameter(string name, uint value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
uint	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetUIntParameter(name: str, value: int)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	int			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.

Syntax

void SetValidateParameterNames(bool validate);

Parameters

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

Syntax

None SetValidateParameterNames(validate: bool)

Parameters

Name	Type	Min	Max	Description
validate	bool			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

Syntax

string ToJSON();

Parameters

ToJSON takes no parameters.

Return value

Type: string

Syntax

str ToJSON()

Parameters

ToJSON takes no parameters.

Return value

Type: str

ValidateSettings

Validates the current settings values.

Syntax

bool ValidateSettings() const;

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

Syntax

bool ValidateSettings();

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

Syntax

bool ValidateSettings()

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

Syntax

static bool IsClassA(string type);

Parameters

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

Return value

Type: bool

Syntax

@staticmethod
bool IsClassA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			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 spPartRemoverSettings, and if this is the case, returns the object cast into spPartRemoverSettings. (Inherited from Object)

Syntax

static spPartRemoverSettings SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: PartRemoverSettings

Syntax

static spPartRemoverSettings SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: PartRemoverSettings

Syntax

@staticmethod
spPartRemoverSettings SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: PartRemoverSettings