Simplygon C++ API  8.3.35800.0
SimplygonSDK::IRemeshingProcessor Class Referenceabstract

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IRemeshingProcessor:
SimplygonSDK::IProcessingObject SimplygonSDK::IObject

Public Member Functions

virtual CountedPointer< IBoneSettingsGetBoneSettings ()=0
 
virtual const char * GetClass ()
 
virtual CountedPointer< IMappingImageGetMappingImage ()=0
 
virtual CountedPointer< IMappingImageGetMappingImage (rid value)=0
 
virtual CountedPointer< IMappingImageSettingsGetMappingImageSettings ()=0
 
virtual CountedPointer< IRemeshingSettingsGetRemeshingSettings ()=0
 
virtual rid GetResultSelectionSetId ()=0
 
virtual CountedPointer< ISceneGetScene ()=0
 
virtual CountedPointer< IVisibilitySettingsGetVisibilitySettings ()=0
 
virtual bool IsA (const char *type) const
 
virtual SGDEPRECATED void RemeshGeometry ()=0
 
virtual void SetScene (IScene *value)=0
 
- Public Member Functions inherited from SimplygonSDK::IProcessingObject
virtual void Clear ()=0
 
virtual real GetPercentDone ()=0
 
virtual void RunProcessing ()=0
 
- Public Member Functions inherited from SimplygonSDK::IObject
virtual rid AddObserver (robserver *Observer, rid EventId)=0
 
virtual void AddRef ()=0
 
virtual rstring GetName ()=0
 
virtual void * GetUserComponentArea (rid userid)=0
 
virtual void PrintInfo ()=0
 
virtual void Release ()=0
 
virtual void RemoveObserver (rid ObserverId)=0
 
virtual void SetName (const char *Name)=0
 

Static Public Member Functions

static bool IsClassA (const char *type)
 
static IRemeshingProcessorSafeCast (IObject *ptr)
 
- Static Public Member Functions inherited from SimplygonSDK::IProcessingObject
static bool IsClassA (const char *type)
 
static IProcessingObjectSafeCast (IObject *ptr)
 
- Static Public Member Functions inherited from SimplygonSDK::IObject
static bool IsClassA (const char *type)
 
static IObjectSafeCast (IObject *ptr)
 

Detailed Description

IRemeshingProcessor 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.

Definition at line 13745 of file SimplygonSDK.h.

Member Function Documentation

◆ GetBoneSettings()

virtual CountedPointer<IBoneSettings> SimplygonSDK::IRemeshingProcessor::GetBoneSettings ( )
pure virtual

The settings for the bone removal process.

Returns
the bone settings object

◆ GetClass()

virtual const char* SimplygonSDK::IRemeshingProcessor::GetClass ( )
virtual

GetClass returns the name of the class of the object.

Returns
the name of the actual class of the object, as a const char string

Reimplemented from SimplygonSDK::IProcessingObject.

◆ GetMappingImage() [1/2]

virtual CountedPointer<IMappingImage> SimplygonSDK::IRemeshingProcessor::GetMappingImage ( )
pure virtual

Get the MappingImage object that is generated if MappingImageSettings::GenerateMappingImage is set. The object is of type IMappingImage. A new object is generated for each call to RunProcessing().

Returns
the current mappingimage

◆ GetMappingImage() [2/2]

virtual CountedPointer<IMappingImage> SimplygonSDK::IRemeshingProcessor::GetMappingImage ( rid  value)
pure virtual

Get the MappingImage object that is generated if MappingImageSettings::GenerateMappingImage is set. The object is of type IMappingImage. A new object is generated for each call to RunProcessing().

Parameters
valuethe ID of the mapping image
Returns
the current mappingimage

◆ GetMappingImageSettings()

virtual CountedPointer<IMappingImageSettings> SimplygonSDK::IRemeshingProcessor::GetMappingImageSettings ( )
pure virtual

The settings for the image mapping process.

Returns
the mapping image settings object

◆ GetRemeshingSettings()

virtual CountedPointer<IRemeshingSettings> SimplygonSDK::IRemeshingProcessor::GetRemeshingSettings ( )
pure virtual

The settings for the remeshing process.

Returns
the remeshing settings object

◆ GetResultSelectionSetId()

virtual rid SimplygonSDK::IRemeshingProcessor::GetResultSelectionSetId ( )
pure virtual

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.

Returns
the remeshed geometry selection set id

◆ GetScene()

virtual CountedPointer<IScene> SimplygonSDK::IRemeshingProcessor::GetScene ( )
pure virtual

Get 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.

Returns
the current scene

◆ GetVisibilitySettings()

virtual CountedPointer<IVisibilitySettings> SimplygonSDK::IRemeshingProcessor::GetVisibilitySettings ( )
pure virtual

The settings for handling visibility weights.

Returns
the visibility settings object associated with the processor

◆ IsA()

virtual bool SimplygonSDK::IRemeshingProcessor::IsA ( const char *  type) const
virtual

The IsA function returns true if the object is a or is a descendant of the class named as the type parameter

Parameters
typeis the name of the class to check if the object is, or is a descendant of
Returns
true if the object is of the specified class, false if not

Reimplemented from SimplygonSDK::IProcessingObject.

◆ IsClassA()

static bool SimplygonSDK::IRemeshingProcessor::IsClassA ( const char *  type)
inlinestatic

The IsClassA function returns true if IRemeshingProcessor is a or is a descendant of the class named as the type parameter

Parameters
typeis the name of the class to check if the class is, or is a descendant of
Returns
true if the class is of the specified class, false if not

Definition at line 13766 of file SimplygonSDK.h.

◆ RemeshGeometry()

virtual SGDEPRECATED void SimplygonSDK::IRemeshingProcessor::RemeshGeometry ( )
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use RunProcessing() instead. Runs the remeshing of the geometry. Alias of RunProcessing.

◆ SafeCast()

static IRemeshingProcessor* SimplygonSDK::IRemeshingProcessor::SafeCast ( IObject ptr)
inlinestatic

SafeCast makes sure the pointer is of a class that can be cast into a IRemeshingProcessor pointer, and if this is possible, returns the cast pointer.

Parameters
ptris the pointer to be cast into a IRemeshingProcessor pointer
Returns
a pointer to the IRemeshingProcessor object, if the cast can be made, and a NULL pointer otherwise

Definition at line 13779 of file SimplygonSDK.h.

◆ SetScene()

virtual void SimplygonSDK::IRemeshingProcessor::SetScene ( IScene value)
pure virtual

Set 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.

Parameters
valuethe scene to process

The documentation for this class was generated from the following file: