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

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IReductionProcessor:
SimplygonSDK::IProcessingObject SimplygonSDK::IObject

Public Member Functions

virtual CountedPointer< IBoneSettingsGetBoneSettings ()=0
 
virtual const char * GetClass ()
 
virtual CountedPointer< IMappingImageGetMappingImage ()=0
 
virtual CountedPointer< IMappingImageGetMappingImage (rid OutputMaterialId)=0
 
virtual CountedPointer< IMappingImageSettingsGetMappingImageSettings ()=0
 
virtual CountedPointer< INormalCalculationSettingsGetNormalCalculationSettings ()=0
 
virtual CountedPointer< IReductionSettingsGetReductionSettings ()=0
 
virtual CountedPointer< IRepairSettingsGetRepairSettings ()=0
 
virtual real GetResultDeviation ()=0
 
virtual CountedPointer< ISceneGetScene ()=0
 
virtual CountedPointer< IVisibilitySettingsGetVisibilitySettings ()=0
 
virtual bool IsA (const char *type) const
 
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 IReductionProcessorSafeCast (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

IReductionProcessor welds, removes t-junctions, removes double-triangles and reduces the trianglecount of the Geometry. It also calculates new normals for the reduced and optimized Geometry.

Definition at line 13042 of file SimplygonSDK.h.

Member Function Documentation

◆ GetBoneSettings()

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

The settings for the bone removal process.

Returns
the bone settings object associated with the processor

◆ GetClass()

virtual const char* SimplygonSDK::IReductionProcessor::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::IReductionProcessor::GetMappingImage ( )
pure virtual

Get the MappingImage object that is generated if MappingImageSettings::GenerateMappingImage is set. The object is of type IMappingImage. If 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().

Returns
the generated mappingimage

◆ GetMappingImage() [2/2]

virtual CountedPointer<IMappingImage> SimplygonSDK::IReductionProcessor::GetMappingImage ( rid  OutputMaterialId)
pure virtual

Get the MappingImage object that is generated if MappingImageSettings::GenerateMappingImage is set. The object is of type IMappingImage. If 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().

Parameters
OutputMaterialIdthe value for the OutputMaterialId
Returns
the generated mappingimage

◆ GetMappingImageSettings()

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

The settings for the image mapping process.

Returns
the mappingimage settings object associated with the processor

◆ GetNormalCalculationSettings()

virtual CountedPointer<INormalCalculationSettings> SimplygonSDK::IReductionProcessor::GetNormalCalculationSettings ( )
pure virtual

The settings for the normal repair process.

Returns
the normal repair settings object associated with the processor

◆ GetReductionSettings()

virtual CountedPointer<IReductionSettings> SimplygonSDK::IReductionProcessor::GetReductionSettings ( )
pure virtual

The settings for the reduction process.

Returns
the reduction settings object associated with the processor

◆ GetRepairSettings()

virtual CountedPointer<IRepairSettings> SimplygonSDK::IReductionProcessor::GetRepairSettings ( )
pure virtual

The settings for the repair process.

Returns
the repair settings object associated with the processor

◆ GetResultDeviation()

virtual real SimplygonSDK::IReductionProcessor::GetResultDeviation ( )
pure virtual

Returns the max deviation reached for the last processing

Returns
the max deviation of the last processing

◆ GetScene()

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

Set the scene object to reduce. 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::IReductionProcessor::GetVisibilitySettings ( )
pure virtual

The settings for handling visibility weights.

Returns
the visibility settings object associated with the processor

◆ IsA()

virtual bool SimplygonSDK::IReductionProcessor::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::IReductionProcessor::IsClassA ( const char *  type)
inlinestatic

The IsClassA function returns true if IReductionProcessor 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 13063 of file SimplygonSDK.h.

◆ SafeCast()

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

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

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

Definition at line 13076 of file SimplygonSDK.h.

◆ SetScene()

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

Set the scene object to reduce. 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 reduce

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