class PackedGeometryData ​

PackedGeometryData keeps the same information as GeometryData, but with all corner data fields moved into per-vertex fields. No per-corner fields exist, apart from the VertexIds field. Please note that the number of vertices in an PackedGeometryData is commonly higher than in an GeometryData, as vertices must be split to accommodate for different corner data.

See also: GeometryData

Properties ​

Methods ​

Static methods ​

Properties details ​

Name ​

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

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

// Setter
void SetName(string name);

// Getter
string GetName();

# Setter
None SetName(name: str)

# Getter
str GetName()

TriangleCount ​

The number of triangles in the geometry.

// Setter
void SetTriangleCount( unsigned int count ) const;

// Getter
unsigned int GetTriangleCount() const;

// Setter
void SetTriangleCount(uint count);

// Getter
uint GetTriangleCount();

# Setter
None SetTriangleCount(count: int)

# Getter
int GetTriangleCount()

VertexCount ​

The number of vertices in the geometry.

// Setter
void SetVertexCount( unsigned int count ) const;

// Getter
unsigned int GetVertexCount() const;

// Setter
void SetVertexCount(uint count);

// Getter
uint GetVertexCount();

# Setter
None SetVertexCount(count: int)

# Getter
int GetVertexCount()

Methods details ​

AddBaseTypeUserTriangleField ​

Adds an empty user-specified triangle field. To be able to add a field, it must have a name that does not conflict with the existing triangle fields.

spValueArray AddBaseTypeUserTriangleField( Simplygon::EBaseTypes baseType , const char * name , unsigned int tupleSize ) const;

spValueArray AddBaseTypeUserTriangleField(EBaseTypes baseType, string name, uint tupleSize);

spValueArray AddBaseTypeUserTriangleField(baseType: EBaseTypes_*, name: str, tupleSize: int)

AddBaseTypeUserVertexField ​

Adds an empty user-specified vertex field. To be able to add a field, it must have a name that does not conflict with the existing vertex fields.

spValueArray AddBaseTypeUserVertexField( Simplygon::EBaseTypes baseType , const char * name , unsigned int tupleSize ) const;

spValueArray AddBaseTypeUserVertexField(EBaseTypes baseType, string name, uint tupleSize);

spValueArray AddBaseTypeUserVertexField(baseType: EBaseTypes_*, name: str, tupleSize: int)

AddBoneWeights ​

Adds the BoneWeights and BoneIds fields in the vertices. The BoneWeights and BoneIds fields are added and removed in unison, and should always be the same tuple size. (Field names: "BoneWeights" & "BoneIds", Tuple size: varying , Stored as: Vertex attribute)

void AddBoneWeights( unsigned int tupleSize ) const;

void AddBoneWeights(uint tupleSize);

None AddBoneWeights(tupleSize: int)

AddColors ​

Adds a Color field in the vertices. The valid id range of the level parameter is 0-255, which equals fields 'Colors0' - 'Colors255' (Field name: "Colors0" - "Colors255", Tuple size: 4 , Stored as: Vertex attribute)

void AddColors( rid level ) const;

void AddColors(int level);

None AddColors(level: int)

AddGroupIds ​

Adds the GroupIds field in the triangles. (Field name: "GroupIds", Tuple size: 1 , Stored as: triangle attribute)

void AddGroupIds() const;

void AddGroupIds();

None AddGroupIds()

AddMaterialIds ​

Adds the MaterialIds field in the triangles. (Field name: "MaterialIds", Tuple size: 1 , Stored as: triangle attribute)

void AddMaterialIds() const;

void AddMaterialIds();

None AddMaterialIds()

AddNamedColors ​

Adds a named Color field in the corners. (Field name: "Colors0" - "Colors255", Tuple size: 4 , Stored as: Corner attribute)

rid AddNamedColors( const char * alternativeName ) const;

int AddNamedColors(string alternativeName);

int AddNamedColors(alternativeName: str)

AddNamedTexCoords ​

Adds a named TexCoords field in the corners. (Field name: "TexCoords0" - "TexCoords255", Tuple size: 2 , Stored as: Corner attribute)

rid AddNamedTexCoords( const char * alternativeName ) const;

int AddNamedTexCoords(string alternativeName);

int AddNamedTexCoords(alternativeName: str)

AddNormals ​

Adds the Normals field in the vertices. (Field name: "Normals" , Tuple size: 3 , Stored as: Vertex attribute)

void AddNormals() const;

void AddNormals();

None AddNormals()

AddObserver ​

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

rid AddObserver( const spObserver & observer ) const;

int AddObserver(spObserver observer);

int AddObserver(observer: spObserver)

AddTangents ​

Adds a Tangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute)

void AddTangents( rid level ) const;

void AddTangents(int level);

None AddTangents(level: int)

AddTexCoords ​

Adds a TexCoords field in the vertices. The valid id range of the level parameter is 0-255, which equals fields 'TexCoords0' - 'TexCoords255' (Field name: "TexCoords0" - "TexCoords255", Tuple size: 2 , Stored as: Vertex attribute)

void AddTexCoords( rid level ) const;

void AddTexCoords(int level);

None AddTexCoords(level: int)

AddTriangles ​

Increases the triangle count by the specified value.

void AddTriangles( unsigned int count ) const;

void AddTriangles(uint count);

None AddTriangles(count: int)

AddUserTriangleField ​

Adds a user-specified triangle field from an already populated array. To be able to add a field, it must have a name that does not conflict with the existing triangle fields.

void AddUserTriangleField( const spValueArray & field ) const;

void AddUserTriangleField(spValueArray field);

None AddUserTriangleField(field: spValueArray)

AddUserVertexField ​

Adds a user-specified vertex field from an already populated value array. To be able to add a field, it must have a name that does not conflict with the existing vertex fields.

void AddUserVertexField( const spValueArray & field ) const;

void AddUserVertexField(spValueArray field);

None AddUserVertexField(field: spValueArray)

AddVertexLocks ​

Adds the VertexLocks field for the vertices. If the value for a vertex is true, then the vertex should be locked, and not be removed in the collapse-process. (Field name: "VertexLocks", Tuple size: 1 , Stored as: Vertex attribute)

void AddVertexLocks() const;

void AddVertexLocks();

None AddVertexLocks()

AddVertexWeighting ​

Adds the VertexWeighting field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)

void AddVertexWeighting() const;

void AddVertexWeighting();

None AddVertexWeighting()

AddVertexWeights ​

Adds the VertexWeights field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)

void AddVertexWeights() const;

void AddVertexWeights();

None AddVertexWeights()

AddVertices ​

AddVertices increases the vertex count by the specified value.

void AddVertices( unsigned int count ) const;

void AddVertices(uint count);

None AddVertices(count: int)

AppendPackedGeometry ​

Appends all vertex-tuples in "source" that don't already exists in the current GeometryData. For each vertex field in this PackedGeometryData, the "source" must contain a corresponding vertex or corner field. All extra-fields in "source" will be skipped however. Returns the number of new and unique vertices created, and the NewVertexIds will contain the indices for the triangles of the "source" Geometry. The VertexIds of the current GeometryData will still be valid. If collapseToOriginalVertices is set to true, all vertices from source will be collapsed to the closest matching vertex of the current geometry. This means that no new vertices will be added, so the returned value will always be 0. If the "NewVertexIds"-array is not initiated before send into this function, it will do nothing and return -1 instead, as error value. The method does not append triangle ids or triangle field data from "source" to the current object.

int AppendPackedGeometry( const spGeometryData & source , const spRidArray & newVertexIds , bool collapseToOriginalVertices ) const;

int AppendPackedGeometry(spGeometryData source, spRidArray newVertexIds, bool collapseToOriginalVertices);

int AppendPackedGeometry(source: spGeometryData, newVertexIds: spRidArray, collapseToOriginalVertices: bool)

DeepCopy ​

Copies the field setup and data from another object. To only copy the setup, set copy_data to false.

void DeepCopy( const spPackedGeometryData & source , bool copyData ) const;

void DeepCopy(spPackedGeometryData source, bool copyData);

None DeepCopy(source: spPackedGeometryData, copyData: bool)

GetBitangents ​

Gets a Bitangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute)

spRealArray GetBitangents( rid level ) const;

spRealArray GetBitangents(int level);

spRealArray GetBitangents(level: int)

GetBoneIds ​

The BoneIds field. (Field name: "BoneIds", Tuple size: varying , Stored as: Vertex attribute)

spRidArray GetBoneIds() const;

spRidArray GetBoneIds();

spRidArray GetBoneIds()

GetBoneWeights ​

The BoneWeights field. (Field name: "BoneWeights", Tuple size: varying , Stored as: Vertex attribute)

spRealArray GetBoneWeights() const;

spRealArray GetBoneWeights();

spRealArray GetBoneWeights()

GetClass ​

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

spString GetClass() const;

string GetClass();

str GetClass()

GetColors ​

Gets a Color field in the vertices. The valid id range of the level parameter is 0-255, which equals fields 'Colors0' - 'Colors255' (Field name: "Colors0" - "Colors255", Tuple size: 4 , Stored as: Vertex attribute)

spRealArray GetColors( rid level ) const;

spRealArray GetColors(int level);

spRealArray GetColors(level: int)

GetCoords ​

The Coords field in the vertices. (Field name: "Coords", Tuple size: 3 , Stored as: Vertex attribute)

spRealArray GetCoords() const;

spRealArray GetCoords();

spRealArray GetCoords()

GetExtents ​

Get the extents object in the geometry.

spExtents GetExtents() const;

spExtents GetExtents();

spExtents GetExtents()

GetGroupIds ​

The GroupIds field in the triangles. (Field name: "GroupIds", Tuple size: 1 , Stored as: triangle attribute)

spRidArray GetGroupIds() const;

spRidArray GetGroupIds();

spRidArray GetGroupIds()

GetInf ​

The inferior (minimum) extent of the geometry.

spRealData GetInf() const;

spRealData GetInf();

spRealData GetInf()

GetMaterialIds ​

The MaterialIds field in the triangles. (Field name: "MaterialIds", Tuple size: 1 , Stored as: triangle attribute)

spRidArray GetMaterialIds() const;

spRidArray GetMaterialIds();

spRidArray GetMaterialIds()

GetNamedColors ​

Gets a Color field, using the alternative name instead of the index.

spRealArray GetNamedColors( const char * alternativeName ) const;

spRealArray GetNamedColors(string alternativeName);

spRealArray GetNamedColors(alternativeName: str)

GetNamedTexCoords ​

Gets a TexCoords field, using the alternative name instead of the index.

spRealArray GetNamedTexCoords( const char * alternativeName ) const;

spRealArray GetNamedTexCoords(string alternativeName);

spRealArray GetNamedTexCoords(alternativeName: str)

GetNormals ​

The Normals field in the vertices. (Field name: "Normals" , Tuple size: 3 , Stored as: Vertex attribute)

spRealArray GetNormals() const;

spRealArray GetNormals();

spRealArray GetNormals()

GetSup ​

The superior (maximum) extent of the geometry.

spRealData GetSup() const;

spRealData GetSup();

spRealData GetSup()

GetTangents ​

Gets a Tangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute)

spRealArray GetTangents( rid level ) const;

spRealArray GetTangents(int level);

spRealArray GetTangents(level: int)

GetTexCoords ​

Gets a TexCoords field in the vertices. The valid id range of the level parameter is 0-255, which equals fields 'TexCoords0' - 'TexCoords255' (Field name: "TexCoords0" - "TexCoords255", Tuple size: 2 , Stored as: Vertex attribute)

spRealArray GetTexCoords( rid level ) const;

spRealArray GetTexCoords(int level);

spRealArray GetTexCoords(level: int)

GetTriangles ​

Retrieves the ReFieldData object that contains the triangle fields.

spFieldData GetTriangles() const;

spFieldData GetTriangles();

spFieldData GetTriangles()

GetUserTriangleField ​

Gets a user-specified triangle field. To be able to add a field, it must have a name that does not conflict with the existing triangle fields.

spValueArray GetUserTriangleField( const char * name ) const;

spValueArray GetUserTriangleField(string name);

spValueArray GetUserTriangleField(name: str)

GetUserVertexField ​

Gets a user-specified vertex field.

spValueArray GetUserVertexField( const char * name ) const;

spValueArray GetUserVertexField(string name);

spValueArray GetUserVertexField(name: str)

GetVertexIds ​

The VertexIds field in the triangles.

spRidArray GetVertexIds() const;

spRidArray GetVertexIds();

spRidArray GetVertexIds()

GetVertexLocks ​

The VertexLocks field for the vertices. If the value for a vertex is true, then the vertex should be locked, and not be removed in the collapse-process. (Field name: "VertexLocks", Tuple size: 1 , Stored as: Vertex attribute)

spBoolArray GetVertexLocks() const;

spBoolArray GetVertexLocks();

spBoolArray GetVertexLocks()

GetVertexWeighting ​

The VertexWeighting field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)

spRealArray GetVertexWeighting() const;

spRealArray GetVertexWeighting();

spRealArray GetVertexWeighting()

GetVertexWeights ​

The VertexWeights field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)

spRealArray GetVertexWeights() const;

spRealArray GetVertexWeights();

spRealArray GetVertexWeights()

GetVertices ​

Retrieves the FieldData object that contains the vertex fields.

spFieldData GetVertices() const;

spFieldData GetVertices();

spFieldData GetVertices()

IsA ​

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

bool IsA( const char * type ) const;

bool IsA(string type);

bool IsA(type: str)

IsNull ​

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

bool IsNull() const;

bool IsNull();

bool IsNull()

IsSameObjectAs ​

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

bool IsSameObjectAs( const spObject & object ) const;

bool IsSameObjectAs(spObject object);

bool IsSameObjectAs(object: spObject)

NewCopy ​

Creates another geometry data object with the same field setup. To also copy the data to the new object, set copy_data to true.

spPackedGeometryData NewCopy( bool copyData ) const;

spPackedGeometryData NewCopy(bool copyData);

spPackedGeometryData NewCopy(copyData: bool)

NewUnpackedCopy ​

Creates an "unpacked" GeometryData object. Please note that since the data in the PackedGeometryData structure is per-vertex, you may have to weld the resulting GeometryData to remove vertices with the same spatial coordinates.

spGeometryData NewUnpackedCopy() const;

spGeometryData NewUnpackedCopy();

spGeometryData NewUnpackedCopy()

NonNull ​

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

bool NonNull() const;

bool NonNull();

bool NonNull()

PrintInfo ​

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

void PrintInfo() const;

void PrintInfo();

None PrintInfo()

RemoveBoneWeights ​

Removes the BoneWeights and BoneIds fields in the vertices. The BoneWeights and BoneIds fields are added and removed in unison, and should always be the same tuple size. (Field names: "BoneWeights" & "BoneIds", Tuple size: varying , Stored as: Vertex attribute)

void RemoveBoneWeights() const;

void RemoveBoneWeights();

None RemoveBoneWeights()

RemoveColors ​

Removes a Color field in the vertices. The valid id range of the level parameter is 0-255, which equals fields 'Colors0' - 'Colors255' (Field name: "Colors0" - "Colors255", Tuple size: 4 , Stored as: Vertex attribute)

void RemoveColors( rid level ) const;

void RemoveColors(int level);

None RemoveColors(level: int)

RemoveGroupIds ​

Removes the GroupIds field in the triangles. (Field name: "GroupIds", Tuple size: 1 , Stored as: triangle attribute)

void RemoveGroupIds() const;

void RemoveGroupIds();

None RemoveGroupIds()

RemoveMaterialIds ​

Removes the MaterialIds field in the triangles. (Field name: "MaterialIds", Tuple size: 1 , Stored as: triangle attribute)

void RemoveMaterialIds() const;

void RemoveMaterialIds();

None RemoveMaterialIds()

RemoveNamedColors ​

Removes a named Color field in the corners. (Field name: "Colors0" - "Colors255", Tuple size: 4 , Stored as: Corner attribute)

bool RemoveNamedColors( const char * alternativeName ) const;

bool RemoveNamedColors(string alternativeName);

bool RemoveNamedColors(alternativeName: str)

RemoveNamedTexCoords ​

Removes a named TexCoords field in the corners. 'TexCoords0' - 'TexCoords255' (Field name: "TexCoords0" - "TexCoords255", Tuple size: 2 , Stored as: Corner attribute)

bool RemoveNamedTexCoords( const char * alternativeName ) const;

bool RemoveNamedTexCoords(string alternativeName);

bool RemoveNamedTexCoords(alternativeName: str)

RemoveNormals ​

Removes the Normals field in the vertices. (Field name: "Normals" , Tuple size: 3 , Stored as: Vertex attribute)

void RemoveNormals() const;

void RemoveNormals();

None RemoveNormals()

RemoveObserver ​

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

void RemoveObserver( rid observerId ) const;

void RemoveObserver(int observerId);

None RemoveObserver(observerId: int)

RemoveTangents ​

Removes a Tangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute)

void RemoveTangents( rid level ) const;

void RemoveTangents(int level);

None RemoveTangents(level: int)

RemoveTexCoords ​

Removes a TexCoords field in the vertices. The valid id range of the level parameter is 0-255, which equals fields 'TexCoords0' - 'TexCoords255' (Field name: "TexCoords0" - "TexCoords255", Tuple size: 2 , Stored as: Vertex attribute)

void RemoveTexCoords( rid level ) const;

void RemoveTexCoords(int level);

None RemoveTexCoords(level: int)

RemoveUserTriangleField ​

Removes a user-specified triangle field. To be able to add a field, it must have a name that does not conflict with the existing triangle fields.

void RemoveUserTriangleField( const char * name ) const;

void RemoveUserTriangleField(string name);

None RemoveUserTriangleField(name: str)

RemoveUserVertexField ​

Removes a user-specified vertex field.

void RemoveUserVertexField( const char * name ) const;

void RemoveUserVertexField(string name);

None RemoveUserVertexField(name: str)

RemoveVertexLocks ​

Removes the VertexLocks field for the vertices. If the value for a vertex is true, then the vertex should be locked, and not be removed in the collapse-process. (Field name: "VertexLocks", Tuple size: 1 , Stored as: Vertex attribute)

void RemoveVertexLocks() const;

void RemoveVertexLocks();

None RemoveVertexLocks()

RemoveVertexWeighting ​

Removes the VertexWeighting field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)

void RemoveVertexWeighting() const;

void RemoveVertexWeighting();

None RemoveVertexWeighting()

RemoveVertexWeights ​

Removes the VertexWeights field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)

void RemoveVertexWeights() const;

void RemoveVertexWeights();

None RemoveVertexWeights()

SetInf ​

The inferior (minimum) extent of the geometry.

void SetInf( const real *vec_realInputDataPtr ) const;

void SetInf(float[] vec);

None SetInf(vec: float)

SetSup ​

The superior (maximum) extent of the geometry.

void SetSup( const real *vec_realInputDataPtr ) const;

void SetSup(float[] vec);

None SetSup(vec: float)

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)

static bool IsClassA( const char * type ) const;

static bool IsClassA(string type);

@staticmethod
bool IsClassA(type: str)

SafeCast ​

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

static spPackedGeometryData SafeCast( const spObject & object ) const;

static spPackedGeometryData SafeCast(spObject object);