class GeometryData ​

GeometryData represents a geometric structure consisting of point data (Vertices) and topological data (Triangles). GeometryData may represent a whole geometric object, but can also be used by streaming data filters, and in this way, only represents a part of the object. Different fields in the Vertices and Triangles fields data objects will contain point data and topological data. The standard naming convention used in the filters/renderers are as follows: (Case sensitive naming, other fields may also be present) 'Coords' Positional coordinates of a vertex, expressed with a 3-component real field (XYZ). 'TexCoords0' - 'TexCoords255' Texture coordinates of a vertex, expressed with a 2 components real field. By convention, the existing fields must be sequential, and must start with 'TexCoord0'. 'Normals' Normal vector for the vertex, expressed with a 3-component real field, a normalized (XYZ) vector. 'VertexIds' The id of the current vertex in the primitive. This field is present even if the vertex data is directly specified in the primitive data, to specify topology. The field is of type rid. 'MaterialIds' The material of the primitive. The field is of type rid. The 'Coords' and 'VertexIds' fields always exist in the object, but the other fields are optional. Also, there can exist user fields.

Properties ​

Methods ​

Static methods ​

Properties details ​

Name ​

The name of the GeometryData 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. The number of corners is always set to (TriangleCount*3), so there is no specific method to set the number of corners.

// 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 ​

AddBaseTypeCustomField ​

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

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

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

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

AddBaseTypeUserCornerField ​

Adds an empty user-specified corner field.

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

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

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

AddBaseTypeUserTriangleField ​

Adds an empty user-specified triangle field.

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 a 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 ​

The vertex colors in the input channel from the corners the geometry. The valid id range of the channel parameter is 0-255, which equals fields 'Colors0' - 'Colors255' (Field name: 'Color0'-'Color255' which is stored as attribute per corner)

void AddColors( rid channel ) const;

void AddColors(int channel);

None AddColors(channel: int)

AddCustomField ​

Adds a custom field. To be able to add a field, it must have a name that does not conflict with the existing custom fields.

void AddCustomField( const spValueArray & field ) const;

void AddCustomField(spValueArray field);

None AddCustomField(field: spValueArray)

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 corners. (Field name: "Normals" , Tuple size: 3 , Stored as: Corner 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)

AddQuadFlags ​

Adds the QuadFlags field in the triangles. Quad flags are used to map sequential triangles to quads for the quad reduction processor using the values SG_QUADFLAG_FIRST, SG_QUADFLAG_SECOND to denote triangles in a quad, and SG_QUADFLAG_TRIANGLE to denote true triangles. (Field name: "QuadFlags" , Tuple size: 1 , Stored as: Triangle attribute)

void AddQuadFlags() const;

void AddQuadFlags();

None AddQuadFlags()

AddTangents ​

Adds Tangents and Bitangents fields in the corners. The valid id range of the level parameter is 0-255. (Field names: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Corner attribute)

void AddTangents( rid level ) const;

void AddTangents(int level);

None AddTangents(level: int)

AddTexCoords ​

Adds a TexCoords field in the corners. 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: Corner attribute)

void AddTexCoords( rid level ) const;

void AddTexCoords(int level);

None AddTexCoords(level: int)

AddTriangles ​

AddTriangles increases the triangle count by the specified value.

void AddTriangles( unsigned int count ) const;

void AddTriangles(uint count);

None AddTriangles(count: int)

AddUserCornerField ​

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

void AddUserCornerField( const spValueArray & field ) const;

void AddUserCornerField(spValueArray field);

None AddUserCornerField(field: spValueArray)

AddUserTriangleField ​

Adds 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 AddUserTriangleField( const spValueArray & field ) const;

void AddUserTriangleField(spValueArray field);

None AddUserTriangleField(field: spValueArray)

AddUserVertexField ​

Adds a 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.

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()

AddVertexWeights ​

Adds the VertexWeights field for the vertices. The weights are used to determine how important it is to keep the vertices when the geometry is reduced. 1 means the weight won't change the importance, values closer to 0 means it will be less important, values > 1 means the vertex is more important and less probable to be removed. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)

void AddVertexWeights() const;

void AddVertexWeights();

None AddVertexWeights()

AddVertices ​

Increases the vertex count by the specified value.

void AddVertices( unsigned int count ) const;

void AddVertices(uint count);

None AddVertices(count: int)

AppendGeometry ​

Appends the geometry data to this geometry. This geometry will contain all triangles and vertices of both geometries. The VertexIds that are copied from the source are remapped to point at the vertices, which are appended to the end of the current vertices. Any field in the appended geometry that does not exist in this geometry will be added, with the tuples that are added set to 0. The method will fail if the source geometry has identically named fields, but with different tuple sizes or base types.

void AppendGeometry( const spGeometryData & source ) const;

void AppendGeometry(spGeometryData source);

None AppendGeometry(source: spGeometryData)

CalculateExtents ​

Calculate the extents by checking the coordinates of all vertices in the geometry. Set only_triangles to true to test only vertices that are indexed by a triangle. This is a slower test, and the bounding box may not encompass all vertices' positions. the new extents are found by calling GetInf() and GetSup() afterwards.

void CalculateExtents( bool onlyTriangles ) const;

void CalculateExtents(bool onlyTriangles);

None CalculateExtents(onlyTriangles: bool)

ChangeWinding ​

Change winding.

void ChangeWinding() const;

void ChangeWinding();

None ChangeWinding()

CleanupInvalidTriangles ​

Finds triangles that contain the same vertex more than once, and invalidates them, ie. sets all the vertex id references to -1. These triangles can be culled using Compact().

void CleanupInvalidTriangles() const;

void CleanupInvalidTriangles();

None CleanupInvalidTriangles()

CleanupNanValues ​

Finds all Nan (1.#IND, 1.#INF etc) values in the real/float/double arrays in the GeometryData, and sets them to 0.0 just to make sure all numbers in the GeometryData are legit. Should not be needed if all the data loaded into the GeometryData object is ok to begin with.

void CleanupNanValues() const;

void CleanupNanValues();

None CleanupNanValues()

Compact ​

Removes invalid triangles and vertices not referenced by any triangle. If any vertices are removed, the triangles will be remapped to the new compacted vertex field.

void Compact( bool onlyCompactTriangles ) const;

void Compact(bool onlyCompactTriangles);

None Compact(onlyCompactTriangles: bool)

ConvertHandedness ​

Converts the handedness of the triangle winding, coords, normals and texture coordinates of the geometry from left-handed to right-handed coordinate systems and vice versa. Simplygon generally uses right-handed coordinates, so this conversion needs to be done before processing any left-handed geometry.

void ConvertHandedness() const;

void ConvertHandedness();

None ConvertHandedness()

CopyCombine3Corners ​

Combines three corners via barycentric coordinates. alpha_3 = 1-(alpha_1 + alpha_2) dest = src_1*alpha_1 + src_2*alpha_2 + src_3*alpha_3.

void CopyCombine3Corners( const spGeometryData & source , rid destId , rid srcId1 , rid srcId2 , rid srcId3 , real alpha1 , real alpha2 ) const;

void CopyCombine3Corners(spGeometryData source, int destId, int srcId1, int srcId2, int srcId3, float alpha1, float alpha2);

None CopyCombine3Corners(source: spGeometryData, destId: int, srcId1: int, srcId2: int, srcId3: int, alpha1: float, alpha2: float)

CopyCombine3Triangles ​

Combines the fields of three triangles via barycentric coordinates. alpha_3 = 1-(alpha_1 + alpha_2) dest = src_1*alpha_1 + src_2*alpha_2 + src_3*alpha_3.

void CopyCombine3Triangles( const spGeometryData & source , rid destId , rid srcId1 , rid srcId2 , rid srcId3 , real alpha1 , real alpha2 ) const;

void CopyCombine3Triangles(spGeometryData source, int destId, int srcId1, int srcId2, int srcId3, float alpha1, float alpha2);

None CopyCombine3Triangles(source: spGeometryData, destId: int, srcId1: int, srcId2: int, srcId3: int, alpha1: float, alpha2: float)

CopyCombine3Vertices ​

Combines the fields of three vertices via barycentric coordinates. alpha_3 = 1-(alpha_1 + alpha_2) dest = src_1*alpha_1 + src_2*alpha_2 + src_3*alpha_3.

void CopyCombine3Vertices( const spGeometryData & source , rid destId , rid srcId1 , rid srcId2 , rid srcId3 , real alpha1 , real alpha2 ) const;

void CopyCombine3Vertices(spGeometryData source, int destId, int srcId1, int srcId2, int srcId3, float alpha1, float alpha2);

None CopyCombine3Vertices(source: spGeometryData, destId: int, srcId1: int, srcId2: int, srcId3: int, alpha1: float, alpha2: float)

CopyCombineCorners ​

Combines the fields of two corners by linear interpolation into the destination corner.

void CopyCombineCorners( const spGeometryData & source , rid destId , rid srcId1 , rid srcId2 , real alpha ) const;

void CopyCombineCorners(spGeometryData source, int destId, int srcId1, int srcId2, float alpha);

None CopyCombineCorners(source: spGeometryData, destId: int, srcId1: int, srcId2: int, alpha: float)

CopyCombineTriangles ​

Combines the fields of two triangles by linear interpolation into the destination triangle.

void CopyCombineTriangles( const spGeometryData & source , rid destId , rid srcId1 , rid srcId2 , real alpha ) const;

void CopyCombineTriangles(spGeometryData source, int destId, int srcId1, int srcId2, float alpha);

None CopyCombineTriangles(source: spGeometryData, destId: int, srcId1: int, srcId2: int, alpha: float)

CopyCombineVertices ​

Combines the fields of two vertices by linear interpolation into the destination vertex.

void CopyCombineVertices( const spGeometryData & source , rid destId , rid srcId1 , rid srcId2 , real alpha ) const;

void CopyCombineVertices(spGeometryData source, int destId, int srcId1, int srcId2, float alpha);

None CopyCombineVertices(source: spGeometryData, destId: int, srcId1: int, srcId2: int, alpha: float)

CopyCorner ​

Copies all fields in the specified corner in the source geometry to the destination corner in this geometry .

void CopyCorner( const spGeometryData & source , rid destId , rid srcId ) const;

void CopyCorner(spGeometryData source, int destId, int srcId);

None CopyCorner(source: spGeometryData, destId: int, srcId: int)

CopyTriangle ​

Copies all fields in the specified triangle in the source geometry to the destination triangle in this geometry.

void CopyTriangle( const spGeometryData & source , rid destId , rid srcId ) const;

void CopyTriangle(spGeometryData source, int destId, int srcId);

None CopyTriangle(source: spGeometryData, destId: int, srcId: int)

CopyVertex ​

Copies all fields in the specified vertex in the source geometry to the destination vertex in this geometry.

void CopyVertex( const spGeometryData & source , rid destId , rid srcId ) const;

void CopyVertex(spGeometryData source, int destId, int srcId);

None CopyVertex(source: spGeometryData, destId: int, srcId: int)

CreateAABB ​

Returns an axis aligned bounding box GeometryData of this geometry.

spGeometryData CreateAABB() const;

spGeometryData CreateAABB();

spGeometryData CreateAABB()

DeduplicateVertices ​

Removes redundant duplication of vertex data, so any vertices containing the exact same information are merged, and the triangle VertexIds field will be remapped to the new values.

Simplygon::EErrorCodes DeduplicateVertices() const;

EErrorCodes DeduplicateVertices();

EErrorCodes_* DeduplicateVertices()

DeepCopy ​

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

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

void DeepCopy(spGeometryData source, bool copyData);

None DeepCopy(source: spGeometryData, copyData: bool)

DetectEdgeNeighbors ​

Detect triangle edge neighbors. Neighbor ids are stored in the "SgEdgeNeighbors" Corner field.

void DetectEdgeNeighbors() const;

void DetectEdgeNeighbors();

None DetectEdgeNeighbors()

ExpandVertices ​

Expands the Vertices field data so that there exists one vertex for each of the three corners of each triangle in the geometry. The vertices will be organized identical to the Corners field. The triangles will be remapped to use the new vertices correctly. Expanding the vertex field is required to be able to extract a range of the geometry, and to be able to stream it. Note! This will lead to increased memory requirement, as vertex data is not shared among neighboring triangles. It also removes the connectivity information of the triangles, and effectively detaches all triangles from one another. This call may replace fields in the Vertices field data. Re-query any previously cached field pointer after the call. All user fields are copied as well.

void ExpandVertices() const;

void ExpandVertices();

None ExpandVertices()

ExtentsContainCoords ​

Tests if the extents of the geometry fully contain all vertex coordinates. Note! ExtentsContainCoords() checks all vertices in the geometry, regardless to whether the vertex is referenced by any triangle. Use Compact() to remove any non-referenced vertex before calling ExtentsContainCoords.

bool ExtentsContainCoords() const;

bool ExtentsContainCoords();

bool ExtentsContainCoords()

ExtractRange ​

Extracts a range of triangles with their vertices from the geometry. ExpandVertices() must first be called for the extraction to succeed. ExtractGeometry() can be used to stream geometries in chunks. If writing to a stream, the extracted geometry is guaranteed to have the same setup as the original. Any previous data in the destination will be deleted.

void ExtractRange( const spGeometryData & dest , rid startTriId , unsigned int count ) const;

void ExtractRange(spGeometryData dest, int startTriId, uint count);

None ExtractRange(dest: spGeometryData, startTriId: int, count: int)