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

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IParameterizer:
SimplygonSDK::IObject

Public Member Functions

virtual real GetAutomaticTextureSizeMultiplier ()=0
 
virtual const char * GetClass ()
 
virtual unsigned int GetFeatureFlagsMask ()=0
 
virtual bool GetForcePower2Texture ()=0
 
virtual unsigned int GetGutterSpace ()=0
 
virtual unsigned int GetGutterSpace (unsigned int id)=0
 
virtual unsigned int GetInputMaterialCount ()=0
 
virtual int GetInputOutputMaterialMapping (unsigned int InMaterialId)=0
 
virtual real GetMaxStretch ()=0
 
virtual unsigned int GetOutputMaterialCount ()=0
 
virtual real GetPackingEfficency ()=0
 
virtual unsigned int GetTextureHeight ()=0
 
virtual unsigned int GetTextureHeight (unsigned int id)=0
 
virtual unsigned int GetTextureWidth ()=0
 
virtual unsigned int GetTextureWidth (unsigned int id)=0
 
virtual bool GetUseAutomaticTextureSize ()=0
 
virtual bool GetUseVertexWeights ()=0
 
virtual bool GetUseVisibilityWeights ()=0
 
virtual bool IsA (const char *type) const
 
virtual bool Parameterize (IGeometryData *geom, IRealArray *arr)=0
 
virtual void SetAutomaticTextureSizeMultiplier (real value)=0
 
virtual void SetFeatureFlagsMask (unsigned int value)=0
 
virtual void SetForcePower2Texture (bool value)=0
 
virtual void SetGutterSpace (unsigned int id, unsigned int value)=0
 
virtual void SetGutterSpace (unsigned int value)=0
 
virtual void SetInputMaterialCount (unsigned int value)=0
 
virtual void SetInputOutputMaterialMapping (unsigned int InMaterialId, int OutMaterialId)=0
 
virtual void SetMaxStretch (real value)=0
 
virtual void SetOutputMaterialCount (unsigned int value)=0
 
virtual void SetPackingEfficency (real value)=0
 
virtual void SetTextureHeight (unsigned int id, unsigned int value)=0
 
virtual void SetTextureHeight (unsigned int value)=0
 
virtual void SetTextureWidth (unsigned int id, unsigned int value)=0
 
virtual void SetTextureWidth (unsigned int value)=0
 
virtual void SetUseAutomaticTextureSize (bool value)=0
 
virtual void SetUseVertexWeights (bool value)=0
 
virtual void SetUseVisibilityWeights (bool value)=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 IParameterizerSafeCast (IObject *ptr)
 
- Static Public Member Functions inherited from SimplygonSDK::IObject
static bool IsClassA (const char *type)
 
static IObjectSafeCast (IObject *ptr)
 

Detailed Description

Computes texture coordinates for arbitrary geometry.

Definition at line 7815 of file SimplygonSDK.h.

Member Function Documentation

◆ GetAutomaticTextureSizeMultiplier()

virtual real SimplygonSDK::IParameterizer::GetAutomaticTextureSizeMultiplier ( )
pure virtual

Get the current automatic texture size multiplier.

Returns
the current multiplier

◆ GetClass()

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

◆ GetFeatureFlagsMask()

virtual unsigned int SimplygonSDK::IParameterizer::GetFeatureFlagsMask ( )
pure virtual

Get the FeatureFlagsMask. Any edge that has one of the flags present as a feature edge, will have the edge forced as a parameterization feature.

Returns
the current FeatureFlagsMask

◆ GetForcePower2Texture()

virtual bool SimplygonSDK::IParameterizer::GetForcePower2Texture ( )
pure virtual

If automatic_texture_size is enabled, then force the texture sizes to be a power of 2

Returns
the current flag

◆ GetGutterSpace() [1/2]

virtual unsigned int SimplygonSDK::IParameterizer::GetGutterSpace ( )
pure virtual

Get the minimum number of pixels between charts.

Returns
the current value of GutterSpace

◆ GetGutterSpace() [2/2]

virtual unsigned int SimplygonSDK::IParameterizer::GetGutterSpace ( unsigned int  id)
pure virtual

Get the minimum number of pixels between charts.

Parameters
idthe output material id
Returns
the current value of GutterSpace

◆ GetInputMaterialCount()

virtual unsigned int SimplygonSDK::IParameterizer::GetInputMaterialCount ( )
pure virtual

Get the number of input materials set earlier. 0 signifies that no in-out material mapping is used.

Returns
the current value of InputMaterialCount

◆ GetInputOutputMaterialMapping()

virtual int SimplygonSDK::IParameterizer::GetInputOutputMaterialMapping ( unsigned int  InMaterialId)
pure virtual

Get the previously set material mapping for mat_id.

Parameters
InMaterialIdis input material id
Returns
the currently mapped output material for InMaterialId. -1 means mapping is not set.

◆ GetMaxStretch()

virtual real SimplygonSDK::IParameterizer::GetMaxStretch ( )
pure virtual

Get the maximum allowed texture stretch. Range 0->1

Returns
the current value of MaxStretch

◆ GetOutputMaterialCount()

virtual unsigned int SimplygonSDK::IParameterizer::GetOutputMaterialCount ( )
pure virtual

Get the number of output mapping images that are to be generated.

Returns
the current value of OutputMaterialCount

◆ GetPackingEfficency()

virtual real SimplygonSDK::IParameterizer::GetPackingEfficency ( )
pure virtual

Set/Get the packing performance setting the value is in the range 0->1, where 0 has the lowest packing efficiency, but runs the fastest, and 1 has the highest packing efficiency but runs slower.

Returns
the current value of PackingEfficency

◆ GetTextureHeight() [1/2]

virtual unsigned int SimplygonSDK::IParameterizer::GetTextureHeight ( )
pure virtual

Get the height of the texture to use.

Returns
the current texture height

◆ GetTextureHeight() [2/2]

virtual unsigned int SimplygonSDK::IParameterizer::GetTextureHeight ( unsigned int  id)
pure virtual

Get the height of the texture to use.

Parameters
idthe output material id
Returns
the current texture height

◆ GetTextureWidth() [1/2]

virtual unsigned int SimplygonSDK::IParameterizer::GetTextureWidth ( )
pure virtual

Get the width of the texture to use.

Returns
the current texture width

◆ GetTextureWidth() [2/2]

virtual unsigned int SimplygonSDK::IParameterizer::GetTextureWidth ( unsigned int  id)
pure virtual

Get the width of the texture to use.

Parameters
idthe material id of the output material
Returns
the current texture width

◆ GetUseAutomaticTextureSize()

virtual bool SimplygonSDK::IParameterizer::GetUseAutomaticTextureSize ( )
pure virtual

Set the automatic_texture_size flag. If true, then texture sizes will be computed for the reduced mesh depending on its pixel size on screen.

Returns
the current flag

◆ GetUseVertexWeights()

virtual bool SimplygonSDK::IParameterizer::GetUseVertexWeights ( )
pure virtual

If UseVertexWeights is enabled, the weights help determine the UV charts and their UV area.

Returns
the current flag

◆ GetUseVisibilityWeights()

virtual bool SimplygonSDK::IParameterizer::GetUseVisibilityWeights ( )
pure virtual

If UseVisibilityWeights is enabled, the weights help determine the UV charts and their UV area.

Returns
the current flag

◆ IsA()

virtual bool SimplygonSDK::IParameterizer::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::IObject.

◆ IsClassA()

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

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

◆ Parameterize()

virtual bool SimplygonSDK::IParameterizer::Parameterize ( IGeometryData geom,
IRealArray arr 
)
pure virtual

Executes the parameterization of the geometry.

Parameters
geomis the geometry which is to be parameterized
arrwill contain the completed parameterization
Returns
true if the parameterization succeeds, false otherwise

◆ SafeCast()

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

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

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

Definition at line 7849 of file SimplygonSDK.h.

◆ SetAutomaticTextureSizeMultiplier()

virtual void SimplygonSDK::IParameterizer::SetAutomaticTextureSizeMultiplier ( real  value)
pure virtual

Set a texture dimension length multiplier for the automatic texture size.

Parameters
valuethe desired multiplier

◆ SetFeatureFlagsMask()

virtual void SimplygonSDK::IParameterizer::SetFeatureFlagsMask ( unsigned int  value)
pure virtual

Set the FeatureFlagsMask. Any edge that has one of the flags present as a feature edge, will have the edge forced as a parameterization feature.

Parameters
valueis the mask to which FeatureFlagsMask will be set

◆ SetForcePower2Texture()

virtual void SimplygonSDK::IParameterizer::SetForcePower2Texture ( bool  value)
pure virtual

If automatic_texture_size is enabled, then force the texture sizes to be a power of 2

Parameters
valuethe desired flag

◆ SetGutterSpace() [1/2]

virtual void SimplygonSDK::IParameterizer::SetGutterSpace ( unsigned int  id,
unsigned int  value 
)
pure virtual

Set the minimum number of pixels between charts.

Parameters
idthe output material id
valueis the value to which GutterSpace will be set

◆ SetGutterSpace() [2/2]

virtual void SimplygonSDK::IParameterizer::SetGutterSpace ( unsigned int  value)
pure virtual

Set the minimum number of pixels between charts.

Parameters
valueis the value to which GutterSpace will be set

◆ SetInputMaterialCount()

virtual void SimplygonSDK::IParameterizer::SetInputMaterialCount ( unsigned int  value)
pure virtual

Set the number of input materials used in the original geometry for mapping to multiple output materials. This needs to be set before you can set any specific in-out material mapping. 0 signifies that no in-out material mapping is used, ie. the process will produce one resulting mapping image.

Parameters
valueis the number of outputs

◆ SetInputOutputMaterialMapping()

virtual void SimplygonSDK::IParameterizer::SetInputOutputMaterialMapping ( unsigned int  InMaterialId,
int  OutMaterialId 
)
pure virtual

Set the material mapping for InMaterialId, meaning what material of the generated LOD InMaterialId will be baked into. Both InputMaterialCount and OutputMaterialCount need to be set for this mapping to work, and all original materials need to be mapped to an existing output id.

Parameters
InMaterialIdis input material id
OutMaterialIdis the output material id

◆ SetMaxStretch()

virtual void SimplygonSDK::IParameterizer::SetMaxStretch ( real  value)
pure virtual

Set the maximum allowed texture stretch. Range 0->1

Parameters
valueis the value to which MaxStretch will be set

◆ SetOutputMaterialCount()

virtual void SimplygonSDK::IParameterizer::SetOutputMaterialCount ( unsigned int  value)
pure virtual

Set the number of output mapping images that are to be generated. The triangle field OutputMaterialIds also needs to be set, or the material ids of the original geometry needs to be set to a specific output material in this setting object.

Parameters
valueis the number of outputs Value cannot be less than 1. Value cannot be greater than SG_MAXIMUM_PARAMETERIZER_OUTPUT_MATERIAL_COUNT.

◆ SetPackingEfficency()

virtual void SimplygonSDK::IParameterizer::SetPackingEfficency ( real  value)
pure virtual

Set/Get the packing performance setting the value is in the range 0->1, where 0 has the lowest packing efficiency, but runs the fastest, and 1 has the highest packing efficiency but runs slower.

Parameters
valueis the value to which PackingEfficency will be set

◆ SetTextureHeight() [1/2]

virtual void SimplygonSDK::IParameterizer::SetTextureHeight ( unsigned int  id,
unsigned int  value 
)
pure virtual

Set the height of the texture to use.

Parameters
idthe output material id
valuethe new output texture height

◆ SetTextureHeight() [2/2]

virtual void SimplygonSDK::IParameterizer::SetTextureHeight ( unsigned int  value)
pure virtual

Set the height of the texture to use.

Parameters
valuethe new output texture height

◆ SetTextureWidth() [1/2]

virtual void SimplygonSDK::IParameterizer::SetTextureWidth ( unsigned int  id,
unsigned int  value 
)
pure virtual

Set the width of the texture to use.

Parameters
idis the output material index
valuethe new output texture width

◆ SetTextureWidth() [2/2]

virtual void SimplygonSDK::IParameterizer::SetTextureWidth ( unsigned int  value)
pure virtual

Set the width of the texture to use.

Parameters
valuethe texture width

◆ SetUseAutomaticTextureSize()

virtual void SimplygonSDK::IParameterizer::SetUseAutomaticTextureSize ( bool  value)
pure virtual

Set the automatic_texture_size flag. If true, then texture sizes will be computed for the reduced mesh depending on its pixel size on screen.

Parameters
valuethe desired flag

◆ SetUseVertexWeights()

virtual void SimplygonSDK::IParameterizer::SetUseVertexWeights ( bool  value)
pure virtual

If UseVertexWeights is enabled, the weights help determine the UV charts and their UV area.

Parameters
valuethe desired flag

◆ SetUseVisibilityWeights()

virtual void SimplygonSDK::IParameterizer::SetUseVisibilityWeights ( bool  value)
pure virtual

If UseVisibilityWeights is enabled, the weights help determine the UV charts and their UV area.

Parameters
valuethe desired flag

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