Simplygon 9 Documentation

# class RemeshingLegacyProcessor

RemeshingLegacyProcessor creates a new geometry that is based on the input geometry, but that is topologically based on the size of the input geometry rendered at a specific screen size, and allowed pixel error. The remesher will on demand also add texture coordinates and a mapping texture to the output remeshed geometry. The geometry that is to be remeshed can be defined either using an in-memory geometry data object, or using a geometry file placed on disk, the latter being the preferred method, if the source geometry is very large as it can be swapped in/out of memory as needed.

# Properties

Property Description
Scene The scene used for remeshing processing. All mesh nodes in the whole scene tree will be replaced by one proxy mesh. Please note that internal refrences might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

# Methods

Method Description
Clear Clear all internal states of the object. This will NOT clear the parameters set in the object.
GetBoneSettings The settings for the bone removal process.
GetClass Get the name of the RemeshingLegacyProcessor class.
GetMappingImage The MappingImage object that is generated if GenerateMappingImage is set in the MappingImageSettings. This returns mapping image index 0, use GetMappingImageForImageIndex to retrieve for a specific index. A new object is generated for each call to RunProcessing().
GetMappingImageForImageIndex The MappingImage object that is generated if GenerateMappingImage is set in the MappingImageSettings. Called with an id, it will fetch that specific mapping image if using multi-material output. A new object is generated for each call to RunProcessing().
GetMappingImageSettings The settings for the image mapping process.
GetPercentDone Returns the current progress of the processing as a value between 0 and 100.
GetRemeshingLegacySettings The settings for the remeshing process.
GetResultSelectionSetId When called after processing, this returns the id of a new selection set in the scene which contains the mesh node and geometry created in the remeshing processing.
GetVisibilitySettings The settings for handling visibility weights.
IsA Returns true if RemeshingLegacyProcessor is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the RemeshingLegacyProcessor object is invalid.
RunProcessing Runs the processing the object is designed for.

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

# Properties details

# Scene

The scene used for remeshing processing. All mesh nodes in the whole scene tree will be replaced by one proxy mesh. Please note that internal refrences might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

# Syntax

// Setter
void SetScene( spScene value );

// Getter
spScene GetScene();

# SetScene parameters

Type Name Min Max Description
Scene value The scene to process.

# GetScene return value

Type: Scene

# Methods details

# Clear

Clear all internal states of the object. This will NOT clear the parameters set in the object.

# Syntax

void Clear();

# Parameters

Clear takes no parameters.

# GetBoneSettings

The settings for the bone removal process.

# Syntax

spBoneSettings GetBoneSettings();

# Parameters

GetBoneSettings takes no parameters.

# Return value

Type: BoneSettings

# GetClass

Get the name of the RemeshingLegacyProcessor class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetMappingImage

The MappingImage object that is generated if GenerateMappingImage is set in the MappingImageSettings. This returns mapping image index 0, use GetMappingImageForImageIndex to retrieve for a specific index. A new object is generated for each call to RunProcessing().

# Syntax

spMappingImage GetMappingImage();

# Parameters

GetMappingImage takes no parameters.

# Return value

Type: MappingImage

# GetMappingImageForImageIndex

The MappingImage object that is generated if GenerateMappingImage is set in the MappingImageSettings. Called with an id, it will fetch that specific mapping image if using multi-material output. A new object is generated for each call to RunProcessing().

# Syntax

spMappingImage GetMappingImageForImageIndex( rid value );

# Parameters

Type Name Min Max Description
rid value The ID of the mapping image.

# Return value

Type: MappingImage

# GetMappingImageSettings

The settings for the image mapping process.

# Syntax

spMappingImageSettings GetMappingImageSettings();

# Parameters

GetMappingImageSettings takes no parameters.

# Return value

Type: MappingImageSettings

# GetPercentDone

Returns the current progress of the processing as a value between 0 and 100.

# Syntax

real GetPercentDone();

# Parameters

GetPercentDone takes no parameters.

# Return value

Type: real

# GetRemeshingLegacySettings

The settings for the remeshing process.

# Syntax

spRemeshingLegacySettings GetRemeshingLegacySettings();

# Parameters

GetRemeshingLegacySettings takes no parameters.

# Return value

Type: RemeshingLegacySettings

# GetResultSelectionSetId

When called after processing, this returns the id of a new selection set in the scene which contains the mesh node and geometry created in the remeshing processing.

# Syntax

rid GetResultSelectionSetId();

# Parameters

GetResultSelectionSetId takes no parameters.

# Return value

Type: rid

# GetVisibilitySettings

The settings for handling visibility weights.

# Syntax

spVisibilitySettings GetVisibilitySettings();

# Parameters

GetVisibilitySettings takes no parameters.

# Return value

Type: VisibilitySettings

# IsA

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

# Return value

Type: bool

# IsNull

Returns true if the RemeshingLegacyProcessor object is invalid.

# Syntax

bool IsNull();

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# RunProcessing

Runs the processing the object is designed for.

# Syntax

void RunProcessing();

# Parameters

RunProcessing takes no parameters.

# 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

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spRemeshingLegacyProcessor, and if this is the case, returns the object cast into spRemeshingLegacyProcessor.

# Syntax

static spRemeshingLegacyProcessor SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: RemeshingLegacyProcessor

← RemeshingProcessor →