Skip to content
On this page

class RemeshingProcessor

The RemeshingProcessor takes an input scene and replaces it with a lightweight proxy geometry that resembles the original, but does not share vertex data or parts of the original mesh data. The remeshed object is created and optimized for a certain on-screen pixel size - which means that holes and parts that are close to each other will have their gaps filled if the distance is below a pixel. At default settings, the proxy mesh is assumed to be viewed from the outside. Any interior mesh that cannot be seen is removed. The result is a very light-weight mesh that is highly optimized for real-time viewing, or to speed up off-line rendering of small objects. Simplygon is capable of remeshing arbitrary geometry, including non-manifold surfaces.

Properties

PropertyDescription
NameThe name of the RemeshingProcessor object. (Inherited from Object)
SceneThe scene used for remeshing processing. All mesh nodes in the whole scene tree will be replaced by one proxy mesh. Please note that internal references might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
ClearClear all internal states of the object. This will NOT clear the parameters set in the object. (Inherited from ProcessingObject)
GetAttributeTessellationSettingsThe settings for handling attribute tessellation of the output geometry.
GetBoneSettingsThe settings for the bone removal process.
GetClassGet the name of the RemeshingProcessor class. (Inherited from Object)
GetGeometryCullingSettingsGet settings for volumetric triangle culling functionality.
GetMappingImageThe 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().
GetMappingImageForImageIndexThe 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().
GetMappingImageSettingsThe settings for the image mapping process.
GetPercentDoneReturns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject)
GetRemeshingSettingsThe settings for the remeshing process.
GetVisibilitySettingsThe settings for handling visibility weights. Visibility settings contains the parameters for how to compute the visibility of a scene and how to use it.
IsAReturns true if RemeshingProcessor is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the RemeshingProcessor object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the RemeshingProcessor object is valid. (Inherited from Object)
NonNullReturns true if the RemeshingProcessor object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the RemeshingProcessor object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
RunProcessingRuns the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned. (Inherited from ProcessingObject)
ToJSONGet settings as JSON for debugging purposes. (Inherited from ProcessingObject)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast makes sure the input object is of a class that can be cast into spRemeshingProcessor, and if this is the case, returns the object cast into spRemeshingProcessor. (Inherited from Object)

Properties details

Name

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

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 references might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

Methods details

AddObserver

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

Clear

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

GetAttributeTessellationSettings

The settings for handling attribute tessellation of the output geometry.

GetBoneSettings

The settings for the bone removal process.

GetClass

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

GetGeometryCullingSettings

Get settings for volumetric triangle culling functionality.

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.

GetRemeshingSettings

The settings for the remeshing process.

GetVisibilitySettings

The settings for handling visibility weights. Visibility settings contains the parameters for how to compute the visibility of a scene and how to use it.

IsA

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

IsNull

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

IsSameObjectAs

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

NonNull

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

PrintInfo

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

RemoveObserver

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

RunProcessing

Runs the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned.

ToJSON

Get settings as JSON for debugging purposes.

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)

SafeCast

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