class RemeshingLegacySettings

Remeshing settings for the RemeshingLegacyProcessor class. The remesher creates a completely new lightweight mesh from the input geometry, and is intended to be viewed from the outside. Here you will set the OnScreenSize (larger numbers means a more detailed mesh), merge distance (which fills in smaller gaps) and a cutting plane (where all parts of the input mesh on the far side of that plane will be culled).

Properties

Property	Description
ClippingGeometryEmptySpaceOverride	The clipping geometry empty space override coordinate.
ClippingGeometrySelectionSetID	The ID of the selection set containing the terrain for clipping. If both selection set name and ID are set, the name will be used.
ClippingGeometrySelectionSetName	The name of the selection set containing the terrain for clipping. If both selection set name and ID are set, the name will be used.
CuttingPlaneSelectionSetID	The ID of the selection set containing all the cutting planes that should be used. If set to -1, all cutting planes are selected. Cutting planes will only be used if UseCuttingPlanes is true. If both selection set name and ID are set, the name will be used.
CuttingPlaneSelectionSetName	The name of the selection set containing all the cutting planes that should be used. If the name is not found, all cutting planes are selected. If both selection set name and ID are set, the name will be used.
EmptySpaceOverride	The empty space override coordinate.
HardEdgeAngle	The normal hard angle cutoff in degrees.
MaxTriangleSize	The maximum size in pixels of a generated triangle Any value from 5 pixels and above is allowed. If set to 0, there will be no restriction.
MergeBoldness	The merge boldness. Defined from 0 to 1, low values will only merge deep cavities while high values will merge anything that falls under the merge distance.
MergeDistance	The on-screen merge distance in pixels. Smaller cavities will be removed. This will be capped to the on-screen size of the remeshing.
OnScreenSize	The on-screen rendering size of the geometry. Allowed values are in the range 20 to 4000 pixels.
OutputSceneNodeName	The name of the scene node in the output Scene containing the remeshed geometry.
ProcessSelectionSetID	Selects which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed.
ProcessSelectionSetName	Which selection set should be processed. If the name is not found, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used.
RespectWindingDirection	If true, the remeshing processor will not map backfacing triangles.
SurfaceTransferMode	The surface transfer mode.
TransferColors	If true, vertex color channels will be sampled from the original mesh.
TransferNormals	If true, the vertex normals channel will be sampled from the original mesh.
UseClippingGeometry	If true, the terrain selection set along with the terrain empty space override will be used to clip the remeshed geometry, like a clipping plane.
UseClippingGeometryEmptySpaceOverride	If true, a coordinate in the area that will be considered "outside" for the clipping geometry can be overridden by the user.
UseCuttingPlanes	Set to true to cap the mesh with user defined cutting planes.
UseEmptySpaceOverride	If true, a coordinate in the area that will be considered "outside" can be overridden by the user, allowing the remesher to be used for things like interiors of caves and rooms.
UsePreviewMode	If true, an alternate algorithm is used for the remeshing which is significantly faster, but supports smaller sizes ( up to 1000 OnScreenSize ), does not include any advanced features, and may be less precise.

Methods

Method	Description
GetBoolParameter	Get a named parameter boolean value.
GetClass	Get the name of the RemeshingLegacySettings class.
GetDoubleParameter	Get a named parameter floating point value.
GetErrorString	Returns a string describing the error that was found the last time ValidateSettings was performed.
GetIntParameter	Get a named parameter integer value.
GetStringParameter	Get a named parameter string value.
GetUIntParameter	Get a named parameter unsigned integer value.
IsA	Returns true if RemeshingLegacySettings is a or is a descendant of the class named as the type parameter.
IsNull	Returns true if the RemeshingLegacySettings object is invalid.
SetBoolParameter	Set a named parameter boolean value.
SetDoubleParameter	Set a named parameter floating point value.
SetIntParameter	Set a named parameter integer value.
SetStringParameter	Set a named parameter string value.
SetUIntParameter	Set a named parameter unsigned integer value.
ToJSON	Get settings as JSON for debugging purposes.
ValidateSettings	Validates the current settings values.

Static methods

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

Properties details

ClippingGeometryEmptySpaceOverride

The clipping geometry empty space override coordinate.

Syntax

// Setter
void SetClippingGeometryEmptySpaceOverride( const real *value_realInputDataPtr );

// Getter
spRealData GetClippingGeometryEmptySpaceOverride();

SetClippingGeometryEmptySpaceOverride parameters

Type	Name	Min	Max	Description
RealData	value			Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space.

GetClippingGeometryEmptySpaceOverride return value

Type: RealData

Default: 0.0,0.0,0.0

Syntax

// Setter
void SetClippingGeometryEmptySpaceOverride(float[] value);

// Getter
RealData GetClippingGeometryEmptySpaceOverride();

SetClippingGeometryEmptySpaceOverride parameters

Type	Name	Min	Max	Description
float[]	value			Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space.

GetClippingGeometryEmptySpaceOverride return value

Type: RealData

Default: 0.0,0.0,0.0

Syntax

# Setter
None SetClippingGeometryEmptySpaceOverride(value: float)

# Getter
spRealData GetClippingGeometryEmptySpaceOverride()

SetClippingGeometryEmptySpaceOverride parameters

Name	Type	Min	Max	Description
value	float			Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space.

GetClippingGeometryEmptySpaceOverride return value

Type: float

Default: 0.0,0.0,0.0

ClippingGeometrySelectionSetID

The ID of the selection set containing the terrain for clipping. If both selection set name and ID are set, the name will be used.

Syntax

// Setter
void SetClippingGeometrySelectionSetID( rid value );

// Getter
rid GetClippingGeometrySelectionSetID();

SetClippingGeometrySelectionSetID parameters

Type	Name	Min	Max	Description
rid	value	-1		The ID of the selection set containing the clipping terrain.

GetClippingGeometrySelectionSetID return value

Type: rid

Default: -1

Syntax

// Setter
void SetClippingGeometrySelectionSetID(rid value);

// Getter
rid GetClippingGeometrySelectionSetID();

SetClippingGeometrySelectionSetID parameters

Type	Name	Min	Max	Description
rid	value	-1		The ID of the selection set containing the clipping terrain.

GetClippingGeometrySelectionSetID return value

Type: rid

Default: -1

Syntax

# Setter
None SetClippingGeometrySelectionSetID(value: int)

# Getter
int GetClippingGeometrySelectionSetID()

SetClippingGeometrySelectionSetID parameters

Name	Type	Min	Max	Description
value	int	-1		The ID of the selection set containing the clipping terrain.

GetClippingGeometrySelectionSetID return value

Type: int

Default: -1

ClippingGeometrySelectionSetName

The name of the selection set containing the terrain for clipping. If both selection set name and ID are set, the name will be used.

Syntax

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

// Getter
spString GetClippingGeometrySelectionSetName();

SetClippingGeometrySelectionSetName parameters

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

GetClippingGeometrySelectionSetName return value

Type: spString

Default: nullptr

Syntax

// Setter
void SetClippingGeometrySelectionSetName(string value);

// Getter
string GetClippingGeometrySelectionSetName();

SetClippingGeometrySelectionSetName parameters

Type	Name	Min	Max	Description
string	value			The desired SelectionSet name.

GetClippingGeometrySelectionSetName return value

Type: string

Default: null

Syntax

# Setter
None SetClippingGeometrySelectionSetName(value: str)

# Getter
str GetClippingGeometrySelectionSetName()

SetClippingGeometrySelectionSetName parameters

Name	Type	Min	Max	Description
value	str			The desired SelectionSet name.

GetClippingGeometrySelectionSetName return value

Type: str

Default: None

CuttingPlaneSelectionSetID

The ID of the selection set containing all the cutting planes that should be used. If set to -1, all cutting planes are selected. Cutting planes will only be used if UseCuttingPlanes is true. If both selection set name and ID are set, the name will be used.

Syntax

// Setter
void SetCuttingPlaneSelectionSetID( rid value );

// Getter
rid GetCuttingPlaneSelectionSetID();

SetCuttingPlaneSelectionSetID parameters

Type	Name	Min	Max	Description
rid	value	-1		The ID of the selection set containing the cutting planes.

GetCuttingPlaneSelectionSetID return value

Type: rid

Default: -1

Syntax

// Setter
void SetCuttingPlaneSelectionSetID(rid value);

// Getter
rid GetCuttingPlaneSelectionSetID();

SetCuttingPlaneSelectionSetID parameters

Type	Name	Min	Max	Description
rid	value	-1		The ID of the selection set containing the cutting planes.

GetCuttingPlaneSelectionSetID return value

Type: rid

Default: -1

Syntax

# Setter
None SetCuttingPlaneSelectionSetID(value: int)

# Getter
int GetCuttingPlaneSelectionSetID()

SetCuttingPlaneSelectionSetID parameters

Name	Type	Min	Max	Description
value	int	-1		The ID of the selection set containing the cutting planes.

GetCuttingPlaneSelectionSetID return value

Type: int

Default: -1

CuttingPlaneSelectionSetName

The name of the selection set containing all the cutting planes that should be used. If the name is not found, all cutting planes are selected. If both selection set name and ID are set, the name will be used.

Syntax

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

// Getter
spString GetCuttingPlaneSelectionSetName();

SetCuttingPlaneSelectionSetName parameters

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

GetCuttingPlaneSelectionSetName return value

Type: spString

Default: nullptr

Syntax

// Setter
void SetCuttingPlaneSelectionSetName(string value);

// Getter
string GetCuttingPlaneSelectionSetName();

SetCuttingPlaneSelectionSetName parameters

Type	Name	Min	Max	Description
string	value			The desired SelectionSet name.

GetCuttingPlaneSelectionSetName return value

Type: string

Default: null

Syntax

# Setter
None SetCuttingPlaneSelectionSetName(value: str)

# Getter
str GetCuttingPlaneSelectionSetName()

SetCuttingPlaneSelectionSetName parameters

Name	Type	Min	Max	Description
value	str			The desired SelectionSet name.

GetCuttingPlaneSelectionSetName return value

Type: str

Default: None

EmptySpaceOverride

The empty space override coordinate.

Syntax

// Setter
void SetEmptySpaceOverride( const real *value_realInputDataPtr );

// Getter
spRealData GetEmptySpaceOverride();

SetEmptySpaceOverride parameters

Type	Name	Min	Max	Description
RealData	value			Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space.

GetEmptySpaceOverride return value

Type: RealData

Default: 0.0,0.0,0.0

Syntax

// Setter
void SetEmptySpaceOverride(float[] value);

// Getter
RealData GetEmptySpaceOverride();

SetEmptySpaceOverride parameters

Type	Name	Min	Max	Description
float[]	value			Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space.

GetEmptySpaceOverride return value

Type: RealData

Default: 0.0,0.0,0.0

Syntax

# Setter
None SetEmptySpaceOverride(value: float)

# Getter
spRealData GetEmptySpaceOverride()

SetEmptySpaceOverride parameters

Name	Type	Min	Max	Description
value	float			Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space.

GetEmptySpaceOverride return value

Type: float

Default: 0.0,0.0,0.0

HardEdgeAngle

The normal hard angle cutoff in degrees.

Syntax

// Setter
void SetHardEdgeAngle( real value );

// Getter
real GetHardEdgeAngle();

SetHardEdgeAngle parameters

Type	Name	Min	Max	Description
real	value	0	180	The value to which HardEdgeAngle will be set.

GetHardEdgeAngle return value

Type: real

Default: 60

Syntax

// Setter
void SetHardEdgeAngle(float value);

// Getter
float GetHardEdgeAngle();

SetHardEdgeAngle parameters

Type	Name	Min	Max	Description
float	value	0	180	The value to which HardEdgeAngle will be set.

GetHardEdgeAngle return value

Type: float

Default: 60

Syntax

# Setter
None SetHardEdgeAngle(value: float)

# Getter
float GetHardEdgeAngle()

SetHardEdgeAngle parameters

Name	Type	Min	Max	Description
value	float	0	180	The value to which HardEdgeAngle will be set.

GetHardEdgeAngle return value

Type: float

Default: 60

MaxTriangleSize

The maximum size in pixels of a generated triangle Any value from 5 pixels and above is allowed. If set to 0, there will be no restriction.

Syntax

// Setter
void SetMaxTriangleSize( unsigned int value );

// Getter
unsigned int GetMaxTriangleSize();

SetMaxTriangleSize parameters

Type	Name	Min	Max	Description
unsigned int	value	0	UINT_MAX	The value MaxTriangleSize will be set to.

GetMaxTriangleSize return value

Type: unsigned int

Default: 0

Syntax

// Setter
void SetMaxTriangleSize(uint value);

// Getter
uint GetMaxTriangleSize();

SetMaxTriangleSize parameters

Type	Name	Min	Max	Description
uint	value	0	UINT_MAX	The value MaxTriangleSize will be set to.

GetMaxTriangleSize return value

Type: uint

Default: 0

Syntax

# Setter
None SetMaxTriangleSize(value: int)

# Getter
int GetMaxTriangleSize()

SetMaxTriangleSize parameters

Name	Type	Min	Max	Description
value	int	0	UINT_MAX	The value MaxTriangleSize will be set to.

GetMaxTriangleSize return value

Type: int

Default: 0

MergeBoldness

The merge boldness. Defined from 0 to 1, low values will only merge deep cavities while high values will merge anything that falls under the merge distance.

Syntax

// Setter
void SetMergeBoldness( real value );

// Getter
real GetMergeBoldness();

SetMergeBoldness parameters

Type	Name	Min	Max	Description
real	value	0	1	The value MergeBoldness will be set to.

GetMergeBoldness return value

Type: real

Default: 0.5

Syntax

// Setter
void SetMergeBoldness(float value);

// Getter
float GetMergeBoldness();

SetMergeBoldness parameters

Type	Name	Min	Max	Description
float	value	0	1	The value MergeBoldness will be set to.

GetMergeBoldness return value

Type: float

Default: 0.5

Syntax

# Setter
None SetMergeBoldness(value: float)

# Getter
float GetMergeBoldness()

SetMergeBoldness parameters

Name	Type	Min	Max	Description
value	float	0	1	The value MergeBoldness will be set to.

GetMergeBoldness return value

Type: float

Default: 0.5

MergeDistance

The on-screen merge distance in pixels. Smaller cavities will be removed. This will be capped to the on-screen size of the remeshing.

Syntax

// Setter
void SetMergeDistance( unsigned int value );

// Getter
unsigned int GetMergeDistance();

SetMergeDistance parameters

Type	Name	Min	Max	Description
unsigned int	value	0	4000	The value MergeDistance will be set to.

GetMergeDistance return value

Type: unsigned int

Default: 4

Syntax

// Setter
void SetMergeDistance(uint value);

// Getter
uint GetMergeDistance();

SetMergeDistance parameters

Type	Name	Min	Max	Description
uint	value	0	4000	The value MergeDistance will be set to.

GetMergeDistance return value

Type: uint

Default: 4

Syntax

# Setter
None SetMergeDistance(value: int)

# Getter
int GetMergeDistance()

SetMergeDistance parameters

Name	Type	Min	Max	Description
value	int	0	4000	The value MergeDistance will be set to.

GetMergeDistance return value

Type: int

Default: 4

OnScreenSize

The on-screen rendering size of the geometry. Allowed values are in the range 20 to 4000 pixels.

Syntax

// Setter
void SetOnScreenSize( unsigned int value );

// Getter
unsigned int GetOnScreenSize();

SetOnScreenSize parameters

Type	Name	Min	Max	Description
unsigned int	value	20	4000	The value OnScreenSize will be set to.

GetOnScreenSize return value

Type: unsigned int

Default: 100

Syntax

// Setter
void SetOnScreenSize(uint value);

// Getter
uint GetOnScreenSize();

SetOnScreenSize parameters

Type	Name	Min	Max	Description
uint	value	20	4000	The value OnScreenSize will be set to.

GetOnScreenSize return value

Type: uint

Default: 100

Syntax

# Setter
None SetOnScreenSize(value: int)

# Getter
int GetOnScreenSize()

SetOnScreenSize parameters

Name	Type	Min	Max	Description
value	int	20	4000	The value OnScreenSize will be set to.

GetOnScreenSize return value

Type: int

Default: 100

OutputSceneNodeName

The name of the scene node in the output Scene containing the remeshed geometry.

Syntax

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

// Getter
spString GetOutputSceneNodeName();

SetOutputSceneNodeName parameters

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

GetOutputSceneNodeName return value

Type: spString

Default: nullptr

Syntax

// Setter
void SetOutputSceneNodeName(string value);

// Getter
string GetOutputSceneNodeName();

SetOutputSceneNodeName parameters

Type	Name	Min	Max	Description
string	value			The desired OutputSceneNodeName.

GetOutputSceneNodeName return value

Type: string

Default: null

Syntax

# Setter
None SetOutputSceneNodeName(value: str)

# Getter
str GetOutputSceneNodeName()

SetOutputSceneNodeName parameters

Name	Type	Min	Max	Description
value	str			The desired OutputSceneNodeName.

GetOutputSceneNodeName return value

Type: str

Default: None

ProcessSelectionSetID

Selects which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed.

Syntax

// Setter
void SetProcessSelectionSetID( rid value );

// Getter
rid GetProcessSelectionSetID();

SetProcessSelectionSetID parameters

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

GetProcessSelectionSetID return value

Type: rid

Default: -1

Syntax

// Setter
void SetProcessSelectionSetID(rid value);

// Getter
rid GetProcessSelectionSetID();

SetProcessSelectionSetID parameters

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

GetProcessSelectionSetID return value

Type: rid

Default: -1

Syntax

# Setter
None SetProcessSelectionSetID(value: int)

# Getter
int GetProcessSelectionSetID()

SetProcessSelectionSetID parameters

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

GetProcessSelectionSetID return value

Type: int

Default: -1

ProcessSelectionSetName

Which selection set should be processed. If the name is not found, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used.

Syntax

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

// Getter
spString GetProcessSelectionSetName();

SetProcessSelectionSetName parameters

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

GetProcessSelectionSetName return value

Type: spString

Default: nullptr

Syntax

// Setter
void SetProcessSelectionSetName(string value);

// Getter
string GetProcessSelectionSetName();

SetProcessSelectionSetName parameters

Type	Name	Min	Max	Description
string	value			The desired SelectionSet name.

GetProcessSelectionSetName return value

Type: string

Default: null

Syntax

# Setter
None SetProcessSelectionSetName(value: str)

# Getter
str GetProcessSelectionSetName()

SetProcessSelectionSetName parameters

Name	Type	Min	Max	Description
value	str			The desired SelectionSet name.

GetProcessSelectionSetName return value

Type: str

Default: None

RespectWindingDirection

If true, the remeshing processor will not map backfacing triangles.

Syntax

// Setter
void SetRespectWindingDirection( bool value );

// Getter
bool GetRespectWindingDirection();

SetRespectWindingDirection parameters

Type	Name	Min	Max	Description
bool	value			The desired value of RespectWindingDirection.

GetRespectWindingDirection return value

Type: bool

Default: false

Syntax

// Setter
void SetRespectWindingDirection(bool value);

// Getter
bool GetRespectWindingDirection();

SetRespectWindingDirection parameters

Type	Name	Min	Max	Description
bool	value			The desired value of RespectWindingDirection.

GetRespectWindingDirection return value

Type: bool

Default: false

Syntax

# Setter
None SetRespectWindingDirection(value: bool)

# Getter
bool GetRespectWindingDirection()

SetRespectWindingDirection parameters

Name	Type	Min	Max	Description
value	bool			The desired value of RespectWindingDirection.

GetRespectWindingDirection return value

Type: bool

Default: false

SurfaceTransferMode

The surface transfer mode.

Syntax

// Setter
void SetSurfaceTransferMode( Simplygon::ESurfaceTransferMode value );

// Getter
Simplygon::ESurfaceTransferMode GetSurfaceTransferMode();

SetSurfaceTransferMode parameters

Type	Name	Min	Max	Description
ESurfaceTransferMode	value			The new surface transfer mode.

GetSurfaceTransferMode return value

Type: ESurfaceTransferMode

Default: Accurate

Key	Value	Comment
Fast	0	Faster but with less precise calculations.
Accurate	1	Slower and more accurate.

Syntax

// Setter
void SetSurfaceTransferMode(enum(ESurfaceTransferMode) value);

// Getter
 GetSurfaceTransferMode();

SetSurfaceTransferMode parameters

Type	Name	Min	Max	Description
ESurfaceTransferMode	value			The new surface transfer mode.

GetSurfaceTransferMode return value

Type: ``````

Default: Accurate

Key	Value	Comment
Fast	0	Faster but with less precise calculations.
Accurate	1	Slower and more accurate.

Syntax

# Setter
None SetSurfaceTransferMode(value: ESurfaceTransferMode_*)

# Getter
ESurfaceTransferMode_* GetSurfaceTransferMode()

SetSurfaceTransferMode parameters

Name	Type	Min	Max	Description
value	ESurfaceTransferMode			The new surface transfer mode.

GetSurfaceTransferMode return value

Type: ESurfaceTransferMode

Default: Accurate

Key	Value	Comment
ESurfaceTransferMode_Fast	0	Faster but with less precise calculations.
ESurfaceTransferMode_Accurate	1	Slower and more accurate.

TransferColors

If true, vertex color channels will be sampled from the original mesh.

Syntax

// Setter
void SetTransferColors( bool value );

// Getter
bool GetTransferColors();

SetTransferColors parameters

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

GetTransferColors return value

Type: bool

Default: false

Syntax

// Setter
void SetTransferColors(bool value);

// Getter
bool GetTransferColors();

SetTransferColors parameters

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

GetTransferColors return value

Type: bool

Default: false

Syntax

# Setter
None SetTransferColors(value: bool)

# Getter
bool GetTransferColors()

SetTransferColors parameters

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

GetTransferColors return value

Type: bool

Default: false

TransferNormals

If true, the vertex normals channel will be sampled from the original mesh.

Syntax

// Setter
void SetTransferNormals( bool value );

// Getter
bool GetTransferNormals();

SetTransferNormals parameters

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

GetTransferNormals return value

Type: bool

Default: false

Syntax

// Setter
void SetTransferNormals(bool value);

// Getter
bool GetTransferNormals();

SetTransferNormals parameters

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

GetTransferNormals return value

Type: bool

Default: false

Syntax

# Setter
None SetTransferNormals(value: bool)

# Getter
bool GetTransferNormals()

SetTransferNormals parameters

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

GetTransferNormals return value

Type: bool

Default: false

UseClippingGeometry

If true, the terrain selection set along with the terrain empty space override will be used to clip the remeshed geometry, like a clipping plane.

Syntax

// Setter
void SetUseClippingGeometry( bool value );

// Getter
bool GetUseClippingGeometry();

SetUseClippingGeometry parameters

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

GetUseClippingGeometry return value

Type: bool

Default: false

Syntax

// Setter
void SetUseClippingGeometry(bool value);

// Getter
bool GetUseClippingGeometry();

SetUseClippingGeometry parameters

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

GetUseClippingGeometry return value

Type: bool

Default: false

Syntax

# Setter
None SetUseClippingGeometry(value: bool)

# Getter
bool GetUseClippingGeometry()

SetUseClippingGeometry parameters

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

GetUseClippingGeometry return value

Type: bool

Default: false

UseClippingGeometryEmptySpaceOverride

If true, a coordinate in the area that will be considered "outside" for the clipping geometry can be overridden by the user.

Syntax

// Setter
void SetUseClippingGeometryEmptySpaceOverride( bool value );

// Getter
bool GetUseClippingGeometryEmptySpaceOverride();

SetUseClippingGeometryEmptySpaceOverride parameters

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

GetUseClippingGeometryEmptySpaceOverride return value

Type: bool

Default: false

Syntax

// Setter
void SetUseClippingGeometryEmptySpaceOverride(bool value);

// Getter
bool GetUseClippingGeometryEmptySpaceOverride();

SetUseClippingGeometryEmptySpaceOverride parameters

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

GetUseClippingGeometryEmptySpaceOverride return value

Type: bool

Default: false

Syntax

# Setter
None SetUseClippingGeometryEmptySpaceOverride(value: bool)

# Getter
bool GetUseClippingGeometryEmptySpaceOverride()

SetUseClippingGeometryEmptySpaceOverride parameters

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

GetUseClippingGeometryEmptySpaceOverride return value

Type: bool

Default: false

UseCuttingPlanes

Set to true to cap the mesh with user defined cutting planes.

Syntax

// Setter
void SetUseCuttingPlanes( bool value );

// Getter
bool GetUseCuttingPlanes();

SetUseCuttingPlanes parameters

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

GetUseCuttingPlanes return value

Type: bool

Default: false

Syntax

// Setter
void SetUseCuttingPlanes(bool value);

// Getter
bool GetUseCuttingPlanes();

SetUseCuttingPlanes parameters

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

GetUseCuttingPlanes return value

Type: bool

Default: false

Syntax

# Setter
None SetUseCuttingPlanes(value: bool)

# Getter
bool GetUseCuttingPlanes()

SetUseCuttingPlanes parameters

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

GetUseCuttingPlanes return value

Type: bool

Default: false

UseEmptySpaceOverride

If true, a coordinate in the area that will be considered "outside" can be overridden by the user, allowing the remesher to be used for things like interiors of caves and rooms.

Syntax

// Setter
void SetUseEmptySpaceOverride( bool value );

// Getter
bool GetUseEmptySpaceOverride();

SetUseEmptySpaceOverride parameters

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

GetUseEmptySpaceOverride return value

Type: bool

Default: false

Syntax

// Setter
void SetUseEmptySpaceOverride(bool value);

// Getter
bool GetUseEmptySpaceOverride();

SetUseEmptySpaceOverride parameters

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

GetUseEmptySpaceOverride return value

Type: bool

Default: false

Syntax

# Setter
None SetUseEmptySpaceOverride(value: bool)

# Getter
bool GetUseEmptySpaceOverride()

SetUseEmptySpaceOverride parameters

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

GetUseEmptySpaceOverride return value

Type: bool

Default: false

UsePreviewMode

If true, an alternate algorithm is used for the remeshing which is significantly faster, but supports smaller sizes ( up to 1000 OnScreenSize ), does not include any advanced features, and may be less precise.

Syntax

// Setter
void SetUsePreviewMode( bool value );

// Getter
bool GetUsePreviewMode();

SetUsePreviewMode parameters

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

GetUsePreviewMode return value

Type: bool

Default: false

Syntax

// Setter
void SetUsePreviewMode(bool value);

// Getter
bool GetUsePreviewMode();

SetUsePreviewMode parameters

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

GetUsePreviewMode return value

Type: bool

Default: false

Syntax

# Setter
None SetUsePreviewMode(value: bool)

# Getter
bool GetUsePreviewMode()

SetUsePreviewMode parameters

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

GetUsePreviewMode return value

Type: bool

Default: false

Methods details

GetBoolParameter

Get a named parameter boolean value.

Syntax

bool GetBoolParameter( const char * name );

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 RemeshingLegacySettings class.

Syntax

spString GetClass();

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 );

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();

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 );

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 );

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 );

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 RemeshingLegacySettings is a or is a descendant of the class named as the type parameter.

Syntax

bool IsA( const char * type );

Parameters

Type	Name	Min	Max	Description
const char *	type			Name of the class to check if RemeshingLegacySettings 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 RemeshingLegacySettings 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 RemeshingLegacySettings is, or is a descendant of.

Return value

Type: bool

IsNull

Returns true if the RemeshingLegacySettings object is invalid.

Syntax

bool IsNull();

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

SetBoolParameter

Set a named parameter boolean value.

Syntax

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

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 );

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 );

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 );

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 );

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

ToJSON

Get settings as JSON for debugging purposes.

Syntax

spString ToJSON();

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();

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.

Syntax

static bool IsClassA( const char * type );

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 spRemeshingLegacySettings, and if this is the case, returns the object cast into spRemeshingLegacySettings.

Syntax

static spRemeshingLegacySettings SafeCast( spObject object );

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: RemeshingLegacySettings

Syntax

static spRemeshingLegacySettings SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: RemeshingLegacySettings

Syntax

@staticmethod
spRemeshingLegacySettings SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: RemeshingLegacySettings