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

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IWelder:
SimplygonSDK::IProcessingObject SimplygonSDK::IObject

Public Member Functions

virtual const char * GetClass ()
 
virtual bool GetCompactMesh ()=0
 
virtual bool GetIgnoreVertexLocks ()=0
 
virtual bool GetOnlyBetweenSceneNodes ()=0
 
virtual bool GetOnlyBorders ()=0
 
virtual SGDEPRECATED bool GetOnlyBordersFlag ()=0
 
virtual SGDEPRECATED bool GetOnlyObjectBoundaryFlag ()=0
 
virtual bool GetOnlyWithinMaterial ()=0
 
virtual SGDEPRECATED bool GetOnlyWithinMaterialFlag ()=0
 
virtual bool GetOnlyWithinSceneNode ()=0
 
virtual rstring GetProcessSelectionSetName ()=0
 
virtual unsigned int GetProgressivePasses ()=0
 
virtual CountedPointer< ISceneGetScene ()=0
 
virtual rid GetSelectionSetID ()=0
 
virtual SGDEPRECATED rstring GetSelectionSetName ()=0
 
virtual bool GetUpdateExtents ()=0
 
virtual real GetWeldDist ()=0
 
virtual bool IsA (const char *type) const
 
virtual void SetCompactMesh (bool value)=0
 
virtual void SetIgnoreVertexLocks (bool value)=0
 
virtual void SetOnlyBetweenSceneNodes (bool value)=0
 
virtual void SetOnlyBorders (bool value)=0
 
virtual SGDEPRECATED void SetOnlyBordersFlag (bool onlyBordersFlag)=0
 
virtual SGDEPRECATED void SetOnlyObjectBoundaryFlag (bool onlyObjectBoundaryFlag)=0
 
virtual void SetOnlyWithinMaterial (bool value)=0
 
virtual SGDEPRECATED void SetOnlyWithinMaterialFlag (bool onlyWithinMaterialFlag)=0
 
virtual void SetOnlyWithinSceneNode (bool value)=0
 
virtual void SetProcessSelectionSetName (const char *value)=0
 
virtual void SetProgressivePasses (unsigned int value)=0
 
virtual void SetScene (IScene *value)=0
 
virtual void SetSelectionSetID (rid value)=0
 
virtual SGDEPRECATED void SetSelectionSetName (const char *selectionSetName)=0
 
virtual void SetUpdateExtents (bool value)=0
 
virtual void SetWeldDist (real value)=0
 
virtual SGDEPRECATED void Weld ()=0
 
virtual void WeldGeometry (IGeometryData *geom)=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 IWelderSafeCast (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

welds geometry vertices

Definition at line 21039 of file SimplygonSDK.h.

Member Function Documentation

◆ GetClass()

virtual const char* SimplygonSDK::IWelder::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.

◆ GetCompactMesh()

virtual bool SimplygonSDK::IWelder::GetCompactMesh ( )
pure virtual

CompactMesh. If true, the welder will call Compact on the geometry after welding.

◆ GetIgnoreVertexLocks()

virtual bool SimplygonSDK::IWelder::GetIgnoreVertexLocks ( )
pure virtual

If IgnoreVertexLocks is true, then also vertices that are locked may be welded.

◆ GetOnlyBetweenSceneNodes()

virtual bool SimplygonSDK::IWelder::GetOnlyBetweenSceneNodes ( )
pure virtual

Get the OnlyBetweenSceneNodes flag. If set, only vertices that belong to different scene nodes are considered for the welding.

Returns
the current OnlyBetweenSceneNodes value

◆ GetOnlyBorders()

virtual bool SimplygonSDK::IWelder::GetOnlyBorders ( )
pure virtual

Get the OnlyBorder flag, if set, only vertices that are on the border are considered for the welding

Returns
the current OnlyBorders value

◆ GetOnlyBordersFlag()

virtual SGDEPRECATED bool SimplygonSDK::IWelder::GetOnlyBordersFlag ( )
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use GetOnlyBorders() instead. Get the OnlyBordersFlag flag.

◆ GetOnlyObjectBoundaryFlag()

virtual SGDEPRECATED bool SimplygonSDK::IWelder::GetOnlyObjectBoundaryFlag ( )
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use GetOnlyWithinSceneNode() instead. Get the OnlyObjectBoundaryFlag flag.

◆ GetOnlyWithinMaterial()

virtual bool SimplygonSDK::IWelder::GetOnlyWithinMaterial ( )
pure virtual

Get the OnlyWithinMaterial flag. If set, only vertices that are within the same material are welded. Vertices on material borders are locked.

Returns
the current OnlyWithinMaterial value

◆ GetOnlyWithinMaterialFlag()

virtual SGDEPRECATED bool SimplygonSDK::IWelder::GetOnlyWithinMaterialFlag ( )
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use GetOnlyWithinMaterial() instead. Get the OnlyWithinMaterialFlag flag.

◆ GetOnlyWithinSceneNode()

virtual bool SimplygonSDK::IWelder::GetOnlyWithinSceneNode ( )
pure virtual

Get the OnlyWithinSceneNode flag. If set, only vertices that are within the same scene node are welded.

Returns
the current OnlyWithinSceneNode

◆ GetProcessSelectionSetName()

virtual rstring SimplygonSDK::IWelder::GetProcessSelectionSetName ( )
pure virtual

Selects which SelectionSet should be processed. If set to NULL, all geometries in the scene will be processed. If both ID and Name are set, ID will be used.

Returns
the current SelectionSet name

◆ GetProgressivePasses()

virtual unsigned int SimplygonSDK::IWelder::GetProgressivePasses ( )
pure virtual

Returns the current number of progressive passes.

◆ GetScene()

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

Get the scene

Returns
the input scene

◆ GetSelectionSetID()

virtual rid SimplygonSDK::IWelder::GetSelectionSetID ( )
pure virtual

Set the ID of the SelectionSet containing the meshes to weld If the ID is -1, all meshes are selected

Returns
the ID of the SelectionSet

◆ GetSelectionSetName()

virtual SGDEPRECATED rstring SimplygonSDK::IWelder::GetSelectionSetName ( )
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use GetProcessSelectionSetName() instead. Get the name of the selection set used

◆ GetUpdateExtents()

virtual bool SimplygonSDK::IWelder::GetUpdateExtents ( )
pure virtual

UpdateExtents. If true, the welder will call CalculateExtents on the geometry before welding.

◆ GetWeldDist()

virtual real SimplygonSDK::IWelder::GetWeldDist ( )
pure virtual

Set/Get the distance, below which, the vertices will be welded

◆ IsA()

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

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

◆ SafeCast()

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

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

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

Definition at line 21073 of file SimplygonSDK.h.

◆ SetCompactMesh()

virtual void SimplygonSDK::IWelder::SetCompactMesh ( bool  value)
pure virtual

CompactMesh. If true, the welder will call Compact on the geometry after welding.

Parameters
valuethe desired flag value

◆ SetIgnoreVertexLocks()

virtual void SimplygonSDK::IWelder::SetIgnoreVertexLocks ( bool  value)
pure virtual

If IgnoreVertexLocks is true, then also vertices that are locked may be welded.

Parameters
valuethe desired flag value

◆ SetOnlyBetweenSceneNodes()

virtual void SimplygonSDK::IWelder::SetOnlyBetweenSceneNodes ( bool  value)
pure virtual

Set the OnlyBetweenSceneNodes flag. If set, only vertices that belong to different scene nodes are considered for the welding.

Parameters
valuethe desired flag value

◆ SetOnlyBorders()

virtual void SimplygonSDK::IWelder::SetOnlyBorders ( bool  value)
pure virtual

Set the OnlyBorder flag, if set, only vertices that are on the border are considered for the welding

Parameters
valuethe new OnlyBorders value

◆ SetOnlyBordersFlag()

virtual SGDEPRECATED void SimplygonSDK::IWelder::SetOnlyBordersFlag ( bool  onlyBordersFlag)
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use SetOnlyBorders() instead. Set the OnlyBordersFlag flag.
Parameters
onlyBordersFlagthe desired flag value

◆ SetOnlyObjectBoundaryFlag()

virtual SGDEPRECATED void SimplygonSDK::IWelder::SetOnlyObjectBoundaryFlag ( bool  onlyObjectBoundaryFlag)
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use SetOnlyWithinSceneNode() instead. Set the OnlyObjectBoundaryFlag flag.
Parameters
onlyObjectBoundaryFlagthe desired flag value

◆ SetOnlyWithinMaterial()

virtual void SimplygonSDK::IWelder::SetOnlyWithinMaterial ( bool  value)
pure virtual

Set the OnlyWithinMaterial flag. If set, only vertices that are within the same material are welded. Vertices on material borders are locked.

Parameters
valuethe desired flag value

◆ SetOnlyWithinMaterialFlag()

virtual SGDEPRECATED void SimplygonSDK::IWelder::SetOnlyWithinMaterialFlag ( bool  onlyWithinMaterialFlag)
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use SetOnlyWithinMaterial() instead. Set the OnlyWithinMaterialFlag flag.
Parameters
onlyWithinMaterialFlagthe desired flag value

◆ SetOnlyWithinSceneNode()

virtual void SimplygonSDK::IWelder::SetOnlyWithinSceneNode ( bool  value)
pure virtual

Set the OnlyWithinSceneNode flag. If set, only vertices that are within the same scene node are welded.

Parameters
valuethe desired flag value

◆ SetProcessSelectionSetName()

virtual void SimplygonSDK::IWelder::SetProcessSelectionSetName ( const char *  value)
pure virtual

Selects which SelectionSet should be processed. If ProcessSelectionSetName is not found, all geometries in the scene will be processed. If both ID and Name are set, ID will be used.

Parameters
valuethe desired SelectionSet name

◆ SetProgressivePasses()

virtual void SimplygonSDK::IWelder::SetProgressivePasses ( unsigned int  value)
pure virtual

Sets the number of progressive passes.

Parameters
valuethe number of passes to perform

◆ SetScene()

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

Set the scene

Parameters
valuethe scene object

◆ SetSelectionSetID()

virtual void SimplygonSDK::IWelder::SetSelectionSetID ( rid  value)
pure virtual

Set the ID of the SelectionSet containing the meshes to weld If the ID is -1, all meshes are selected

Parameters
valuethe ID of the selection set to use

◆ SetSelectionSetName()

virtual SGDEPRECATED void SimplygonSDK::IWelder::SetSelectionSetName ( const char *  selectionSetName)
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use SetProcessSelectionSetName() instead. Set the name of the selection to use
Parameters
selectionSetNamethe name of the selection set

◆ SetUpdateExtents()

virtual void SimplygonSDK::IWelder::SetUpdateExtents ( bool  value)
pure virtual

UpdateExtents. If true, the welder will call CalculateExtents on the geometry before welding.

Parameters
valuethe desired flag value

◆ SetWeldDist()

virtual void SimplygonSDK::IWelder::SetWeldDist ( real  value)
pure virtual

Set/Get the distance, below which, the vertices will be welded

Parameters
valuethe weld distance

◆ Weld()

virtual SGDEPRECATED void SimplygonSDK::IWelder::Weld ( )
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use RunProcessing() instead. Weld the geometry. Alias for RunProcessing.

◆ WeldGeometry()

virtual void SimplygonSDK::IWelder::WeldGeometry ( IGeometryData geom)
pure virtual

Welds the geometry

Parameters
geomthe geometry data object

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