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
| Property | Description |
|---|
| TriangleCount | The number of triangles in the geometry. |
| VertexCount | The number of vertices in the geometry. |
Methods
| Method | Description |
|---|
| 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. |
| 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. |
| 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) |
| 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) |
| AddGroupIds | Adds the GroupIds field in the triangles. (Field name: "GroupIds", Tuple size: 1 , Stored as: triangle attribute) |
| AddMaterialIds | Adds the MaterialIds field in the triangles. (Field name: "MaterialIds", Tuple size: 1 , Stored as: triangle attribute) |
| AddNamedColors | Adds a named Color field in the corners. (Field name: "Colors0" - "Colors255", Tuple size: 4 , Stored as: Corner attribute) |
| AddNamedTexCoords | Adds a named TexCoords field in the corners. (Field name: "TexCoords0" - "TexCoords255", Tuple size: 2 , Stored as: Corner attribute) |
| AddNormals | Adds the Normals field in the vertices. (Field name: "Normals" , Tuple size: 3 , Stored as: Vertex attribute) |
| AddTangents | Adds a Tangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute) |
| 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) |
| AddTriangles | Increases the triangle count by the specified value. |
| 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. |
| 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. |
| 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) |
| AddVertexWeighting | Adds the VertexWeighting field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute) |
| AddVertexWeights | Adds the VertexWeights field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute) |
| AddVertices | AddVertices increases the vertex count by the specified value. |
| 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. |
| DeepCopy | Copies the field setup and data from another object. To only copy the setup, set copy_data to false. |
| GetBitangents | Gets a Bitangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute) |
| GetBoneIds | The BoneIds field. (Field name: "BoneIds", Tuple size: varying , Stored as: Vertex attribute) |
| GetBoneWeights | The BoneWeights field. (Field name: "BoneWeights", Tuple size: varying , Stored as: Vertex attribute) |
| GetClass | Get the name of the PackedGeometryData class. |
| 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) |
| GetCoords | The Coords field in the vertices. (Field name: "Coords", Tuple size: 3 , Stored as: Vertex attribute) |
| GetGroupIds | The GroupIds field in the triangles. (Field name: "GroupIds", Tuple size: 1 , Stored as: triangle attribute) |
| GetInf | The inferior (minimum) extent of the geometry. |
| GetMaterialIds | The MaterialIds field in the triangles. (Field name: "MaterialIds", Tuple size: 1 , Stored as: triangle attribute) |
| GetNamedColors | Gets a Color field, using the alternative name instead of the index. |
| GetNamedTexCoords | Gets a TexCoords field, using the alternative name instead of the index. |
| GetNormals | The Normals field in the vertices. (Field name: "Normals" , Tuple size: 3 , Stored as: Vertex attribute) |
| GetSup | The superior (maximum) extent of the geometry. |
| GetTangents | Gets a Tangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute) |
| 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) |
| GetTriangles | Retrieves the ReFieldData object that contains the triangle fields. |
| 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. |
| GetUserVertexField | Gets a user-specified vertex field. |
| GetVertexIds | The VertexIds field in the triangles. |
| 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) |
| GetVertexWeighting | The VertexWeighting field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute) |
| GetVertexWeights | The VertexWeights field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute) |
| GetVertices | Retrieves the FieldData object that contains the vertex fields. |
| IsA | Returns true if PackedGeometryData is a or is a descendant of the class named as the type parameter. |
| IsNull | Returns true if the PackedGeometryData object is invalid. |
| 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. |
| 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. |
| 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) |
| 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) |
| RemoveGroupIds | Removes the GroupIds field in the triangles. (Field name: "GroupIds", Tuple size: 1 , Stored as: triangle attribute) |
| RemoveMaterialIds | Removes the MaterialIds field in the triangles. (Field name: "MaterialIds", Tuple size: 1 , Stored as: triangle attribute) |
| RemoveNamedColors | Removes a named Color field in the corners. (Field name: "Colors0" - "Colors255", Tuple size: 4 , Stored as: Corner attribute) |
| RemoveNamedTexCoords | Removes a named TexCoords field in the corners. 'TexCoords0' - 'TexCoords255' (Field name: "TexCoords0" - "TexCoords255", Tuple size: 2 , Stored as: Corner attribute) |
| RemoveNormals | Removes the Normals field in the vertices. (Field name: "Normals" , Tuple size: 3 , Stored as: Vertex attribute) |
| RemoveTangents | Removes a Tangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute) |
| 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) |
| 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. |
| RemoveUserVertexField | Removes a user-specified vertex field. |
| 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) |
| RemoveVertexWeighting | Removes the VertexWeighting field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute) |
| RemoveVertexWeights | Removes the VertexWeights field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute) |
| SetInf | The inferior (minimum) extent of the geometry. |
| SetSup | The superior (maximum) extent of the geometry. |
Static methods
| Method | Description |
|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. |
| 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. |
Properties details
TriangleCount
The number of triangles in the geometry.
Syntax
SetTriangleCount parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | count | 0 | INT_MAX | The number of triangles to add. |
GetTriangleCount return value
Type: unsigned int
Syntax
SetTriangleCount parameters
| Type | Name | Min | Max | Description |
|---|
uint | count | 0 | INT_MAX | The number of triangles to add. |
GetTriangleCount return value
Type: uint
Syntax
SetTriangleCount parameters
| Name | Type | Min | Max | Description |
|---|
| count | int | 0 | INT_MAX | The number of triangles to add. |
GetTriangleCount return value
Type: int
VertexCount
The number of vertices in the geometry.
Syntax
SetVertexCount parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | count | 0 | INT_MAX | The new vertexcount. |
GetVertexCount return value
Type: unsigned int
Syntax
SetVertexCount parameters
| Type | Name | Min | Max | Description |
|---|
uint | count | 0 | INT_MAX | The new vertexcount. |
GetVertexCount return value
Type: uint
Syntax
SetVertexCount parameters
| Name | Type | Min | Max | Description |
|---|
| count | int | 0 | INT_MAX | The new vertexcount. |
GetVertexCount return value
Type: int
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| EBaseTypes | base_type | | | The type of data in the field, the alternatives can be found in BaseTypes. |
const char * | name | | | The name of the new field. |
unsigned int | tuple_size | | | The tuple size of the new field. |
Return value
Type: ValueArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| EBaseTypes | base_type | | | The type of data in the field, the alternatives can be found in BaseTypes. |
string | name | | | The name of the new field. |
uint | tuple_size | | | The tuple size of the new field. |
Return value
Type: ValueArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| base_type | EBaseTypes | | | The type of data in the field, the alternatives can be found in BaseTypes. |
| name | str | | | The name of the new field. |
| tuple_size | int | | | The tuple size of the new field. |
Return value
Type: ValueArray
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| EBaseTypes | base_type | | | The type of data in the field, the alternatives can be found in BaseTypes. |
const char * | name | | | The name of the new field. |
unsigned int | tuple_size | | | The tuple size of the new field. |
Return value
Type: ValueArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| EBaseTypes | base_type | | | The type of data in the field, the alternatives can be found in BaseTypes. |
string | name | | | The name of the new field. |
uint | tuple_size | | | The tuple size of the new field. |
Return value
Type: ValueArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| base_type | EBaseTypes | | | The type of data in the field, the alternatives can be found in BaseTypes. |
| name | str | | | The name of the new field. |
| tuple_size | int | | | The tuple size of the new field. |
Return value
Type: ValueArray
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | tuplesize | | | The size of the tuples in the new bone weight and bone id field. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
uint | tuplesize | | | The size of the tuples in the new bone weight and bone id field. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| tuplesize | int | | | The size of the tuples in the new bone weight and bone id field. |
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the Color field to add. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the Color field to add. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| level | int | | | The level of the Color field to add. |
AddGroupIds
Adds the GroupIds field in the triangles. (Field name: "GroupIds", Tuple size: 1 , Stored as: triangle attribute)
Syntax
Parameters
AddGroupIds takes no parameters.
Syntax
Parameters
AddGroupIds takes no parameters.
Syntax
Parameters
AddGroupIds takes no parameters.
AddMaterialIds
Adds the MaterialIds field in the triangles. (Field name: "MaterialIds", Tuple size: 1 , Stored as: triangle attribute)
Syntax
Parameters
AddMaterialIds takes no parameters.
Syntax
Parameters
AddMaterialIds takes no parameters.
Syntax
Parameters
AddMaterialIds takes no parameters.
AddNamedColors
Adds a named Color field in the corners. (Field name: "Colors0" - "Colors255", Tuple size: 4 , Stored as: Corner attribute)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | alternative_name | | | The named color channel "Colors0" - "Colors255". |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | alternative_name | | | The named color channel "Colors0" - "Colors255". |
Return value
Type: rid
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| alternative_name | str | | | The named color channel "Colors0" - "Colors255". |
Return value
Type: int
AddNamedTexCoords
Adds a named TexCoords field in the corners. (Field name: "TexCoords0" - "TexCoords255", Tuple size: 2 , Stored as: Corner attribute)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | alternative_name | | | The name of the texcoord level i.e. 'TexCoord0'. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | alternative_name | | | The name of the texcoord level i.e. 'TexCoord0'. |
Return value
Type: rid
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| alternative_name | str | | | The name of the texcoord level i.e. 'TexCoord0'. |
Return value
Type: int
AddNormals
Adds the Normals field in the vertices. (Field name: "Normals" , Tuple size: 3 , Stored as: Vertex attribute)
Syntax
Parameters
AddNormals takes no parameters.
Syntax
Parameters
AddNormals takes no parameters.
Syntax
Parameters
AddNormals takes no parameters.
AddTangents
Adds a Tangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the new tangent fields. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the new tangent fields. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| level | int | | | The level of the new tangent fields. |
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the new texcoord field. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the new texcoord field. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| level | int | | | The level of the new texcoord field. |
AddTriangles
Increases the triangle count by the specified value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | count | | | The number of triangles to add. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
uint | count | | | The number of triangles to add. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| count | int | | | The number of triangles to add. |
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| ValueArray | field | | | The array that is to be added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| ValueArray | field | | | The array that is to be added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| field | ValueArray | | | The array that is to be added. |
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| ValueArray | field | | | The field that is to be added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| ValueArray | field | | | The field that is to be added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| field | ValueArray | | | The field that is to be added. |
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)
Syntax
Parameters
AddVertexLocks takes no parameters.
Syntax
Parameters
AddVertexLocks takes no parameters.
Syntax
Parameters
AddVertexLocks takes no parameters.
AddVertexWeighting
Adds the VertexWeighting field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)
Syntax
Parameters
AddVertexWeighting takes no parameters.
Syntax
Parameters
AddVertexWeighting takes no parameters.
Syntax
Parameters
AddVertexWeighting takes no parameters.
AddVertexWeights
Adds the VertexWeights field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)
Syntax
Parameters
AddVertexWeights takes no parameters.
Syntax
Parameters
AddVertexWeights takes no parameters.
Syntax
Parameters
AddVertexWeights takes no parameters.
AddVertices
AddVertices increases the vertex count by the specified value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | count | | | The number of vertices to add. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
uint | count | | | The number of vertices to add. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| count | int | | | The number of vertices to add. |
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | source | | | The geometry from which to append. |
| RidArray | NewVertexIds | | | Will be written to and contain the indices for the appended geometries triangles. |
bool | collapseToOriginalVertices | | | Will determine if the appended vertices are collapsed to existing ones or not. |
Return value
Type: int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | source | | | The geometry from which to append. |
| RidArray | NewVertexIds | | | Will be written to and contain the indices for the appended geometries triangles. |
bool | collapseToOriginalVertices | | | Will determine if the appended vertices are collapsed to existing ones or not. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| source | GeometryData | | | The geometry from which to append. |
| NewVertexIds | RidArray | | | Will be written to and contain the indices for the appended geometries triangles. |
| collapseToOriginalVertices | bool | | | Will determine if the appended vertices are collapsed to existing ones or not. |
Return value
Type: int
DeepCopy
Copies the field setup and data from another object. To only copy the setup, set copy_data to false.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| PackedGeometryData | source | | | The source from which the data will be copied. |
bool | copy_data | | | The bool determining whether to copy the data or just the field setup. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| PackedGeometryData | source | | | The source from which the data will be copied. |
bool | copy_data | | | The bool determining whether to copy the data or just the field setup. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| source | PackedGeometryData | | | The source from which the data will be copied. |
| copy_data | bool | | | The bool determining whether to copy the data or just the field setup. |
GetBitangents
Gets a Bitangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the bitangent field to get. |
Return value
Type: RealArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the bitangent field to get. |
Return value
Type: RealArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| level | int | | | The level of the bitangent field to get. |
Return value
Type: RealArray
GetBoneIds
The BoneIds field. (Field name: "BoneIds", Tuple size: varying , Stored as: Vertex attribute)
Syntax
Parameters
GetBoneIds takes no parameters.
Return value
Type: RidArray
Syntax
Parameters
GetBoneIds takes no parameters.
Return value
Type: RidArray
Syntax
Parameters
GetBoneIds takes no parameters.
Return value
Type: RidArray
GetBoneWeights
The BoneWeights field. (Field name: "BoneWeights", Tuple size: varying , Stored as: Vertex attribute)
Syntax
Parameters
GetBoneWeights takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetBoneWeights takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetBoneWeights takes no parameters.
Return value
Type: RealArray
GetClass
Get the name of the PackedGeometryData class.
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the Colors field to get. |
Return value
Type: RealArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the Colors field to get. |
Return value
Type: RealArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| level | int | | | The level of the Colors field to get. |
Return value
Type: RealArray
GetCoords
The Coords field in the vertices. (Field name: "Coords", Tuple size: 3 , Stored as: Vertex attribute)
Syntax
Parameters
GetCoords takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetCoords takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetCoords takes no parameters.
Return value
Type: RealArray
GetGroupIds
The GroupIds field in the triangles. (Field name: "GroupIds", Tuple size: 1 , Stored as: triangle attribute)
Syntax
Parameters
GetGroupIds takes no parameters.
Return value
Type: RidArray
Syntax
Parameters
GetGroupIds takes no parameters.
Return value
Type: RidArray
Syntax
Parameters
GetGroupIds takes no parameters.
Return value
Type: RidArray
GetInf
The inferior (minimum) extent of the geometry.
Syntax
Parameters
GetInf takes no parameters.
Return value
Type: RealData
Syntax
Parameters
GetInf takes no parameters.
Return value
Type: RealData
Syntax
Parameters
GetInf takes no parameters.
Return value
Type: float
GetMaterialIds
The MaterialIds field in the triangles. (Field name: "MaterialIds", Tuple size: 1 , Stored as: triangle attribute)
Syntax
Parameters
GetMaterialIds takes no parameters.
Return value
Type: RidArray
Syntax
Parameters
GetMaterialIds takes no parameters.
Return value
Type: RidArray
Syntax
Parameters
GetMaterialIds takes no parameters.
Return value
Type: RidArray
GetNamedColors
Gets a Color field, using the alternative name instead of the index.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | alternative_name | | | The alternative name of the field. |
Return value
Type: RealArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | alternative_name | | | The alternative name of the field. |
Return value
Type: RealArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| alternative_name | str | | | The alternative name of the field. |
Return value
Type: RealArray
GetNamedTexCoords
Gets a TexCoords field, using the alternative name instead of the index.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | alternative_name | | | The alternative name of the field. |
Return value
Type: RealArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | alternative_name | | | The alternative name of the field. |
Return value
Type: RealArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| alternative_name | str | | | The alternative name of the field. |
Return value
Type: RealArray
GetNormals
The Normals field in the vertices. (Field name: "Normals" , Tuple size: 3 , Stored as: Vertex attribute)
Syntax
Parameters
GetNormals takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetNormals takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetNormals takes no parameters.
Return value
Type: RealArray
GetSup
The superior (maximum) extent of the geometry.
Syntax
Parameters
GetSup takes no parameters.
Return value
Type: RealData
Syntax
Parameters
GetSup takes no parameters.
Return value
Type: RealData
Syntax
Parameters
GetSup takes no parameters.
Return value
Type: float
GetTangents
Gets a Tangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the tangent field to get. |
Return value
Type: RealArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the tangent field to get. |
Return value
Type: RealArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| level | int | | | The level of the tangent field to get. |
Return value
Type: RealArray
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the texcoord field to get. |
Return value
Type: RealArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the texcoord field to get. |
Return value
Type: RealArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| level | int | | | The level of the texcoord field to get. |
Return value
Type: RealArray
GetTriangles
Retrieves the ReFieldData object that contains the triangle fields.
Syntax
Parameters
GetTriangles takes no parameters.
Return value
Type: FieldData
Syntax
Parameters
GetTriangles takes no parameters.
Return value
Type: FieldData
Syntax
Parameters
GetTriangles takes no parameters.
Return value
Type: FieldData
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Name of the field to be fetched. |
Return value
Type: ValueArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Name of the field to be fetched. |
Return value
Type: ValueArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Name of the field to be fetched. |
Return value
Type: ValueArray
GetUserVertexField
Gets a user-specified vertex field.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | The name of the field to be fetched. |
Return value
Type: ValueArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | The name of the field to be fetched. |
Return value
Type: ValueArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | The name of the field to be fetched. |
Return value
Type: ValueArray
GetVertexIds
The VertexIds field in the triangles.
Syntax
Parameters
GetVertexIds takes no parameters.
Return value
Type: RidArray
Syntax
Parameters
GetVertexIds takes no parameters.
Return value
Type: RidArray
Syntax
Parameters
GetVertexIds takes no parameters.
Return value
Type: RidArray
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)
Syntax
Parameters
GetVertexLocks takes no parameters.
Return value
Type: BoolArray
Syntax
Parameters
GetVertexLocks takes no parameters.
Return value
Type: BoolArray
Syntax
Parameters
GetVertexLocks takes no parameters.
Return value
Type: BoolArray
GetVertexWeighting
The VertexWeighting field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)
Syntax
Parameters
GetVertexWeighting takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetVertexWeighting takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetVertexWeighting takes no parameters.
Return value
Type: RealArray
GetVertexWeights
The VertexWeights field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)
Syntax
Parameters
GetVertexWeights takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetVertexWeights takes no parameters.
Return value
Type: RealArray
Syntax
Parameters
GetVertexWeights takes no parameters.
Return value
Type: RealArray
GetVertices
Retrieves the FieldData object that contains the vertex fields.
Syntax
Parameters
GetVertices takes no parameters.
Return value
Type: FieldData
Syntax
Parameters
GetVertices takes no parameters.
Return value
Type: FieldData
Syntax
Parameters
GetVertices takes no parameters.
Return value
Type: FieldData
IsA
Returns true if PackedGeometryData is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if PackedGeometryData is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if PackedGeometryData is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if PackedGeometryData is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the PackedGeometryData object is invalid.
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | copy_data | | | Determines if the data is included in the new copy. |
Return value
Type: PackedGeometryData
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | copy_data | | | Determines if the data is included in the new copy. |
Return value
Type: PackedGeometryData
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| copy_data | bool | | | Determines if the data is included in the new copy. |
Return value
Type: PackedGeometryData
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.
Syntax
Parameters
NewUnpackedCopy takes no parameters.
Return value
Type: GeometryData
Syntax
Parameters
NewUnpackedCopy takes no parameters.
Return value
Type: GeometryData
Syntax
Parameters
NewUnpackedCopy takes no parameters.
Return value
Type: GeometryData
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)
Syntax
Parameters
RemoveBoneWeights takes no parameters.
Syntax
Parameters
RemoveBoneWeights takes no parameters.
Syntax
Parameters
RemoveBoneWeights takes no parameters.
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the Color field to remove. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the Color field to remove. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| level | int | | | The level of the Color field to remove. |
RemoveGroupIds
Removes the GroupIds field in the triangles. (Field name: "GroupIds", Tuple size: 1 , Stored as: triangle attribute)
Syntax
Parameters
RemoveGroupIds takes no parameters.
Syntax
Parameters
RemoveGroupIds takes no parameters.
Syntax
Parameters
RemoveGroupIds takes no parameters.
RemoveMaterialIds
Removes the MaterialIds field in the triangles. (Field name: "MaterialIds", Tuple size: 1 , Stored as: triangle attribute)
Syntax
Parameters
RemoveMaterialIds takes no parameters.
Syntax
Parameters
RemoveMaterialIds takes no parameters.
Syntax
Parameters
RemoveMaterialIds takes no parameters.
RemoveNamedColors
Removes a named Color field in the corners. (Field name: "Colors0" - "Colors255", Tuple size: 4 , Stored as: Corner attribute)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | alternative_name | | | The named color channel "Colors0" - "Colors255". |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | alternative_name | | | The named color channel "Colors0" - "Colors255". |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| alternative_name | str | | | The named color channel "Colors0" - "Colors255". |
Return value
Type: bool
RemoveNamedTexCoords
Removes a named TexCoords field in the corners. 'TexCoords0' - 'TexCoords255' (Field name: "TexCoords0" - "TexCoords255", Tuple size: 2 , Stored as: Corner attribute)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | alternative_name | | | The name of the texcoord level i.e. 'TexCoord0'. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | alternative_name | | | The name of the texcoord level i.e. 'TexCoord0'. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| alternative_name | str | | | The name of the texcoord level i.e. 'TexCoord0'. |
Return value
Type: bool
RemoveNormals
Removes the Normals field in the vertices. (Field name: "Normals" , Tuple size: 3 , Stored as: Vertex attribute)
Syntax
Parameters
RemoveNormals takes no parameters.
Syntax
Parameters
RemoveNormals takes no parameters.
Syntax
Parameters
RemoveNormals takes no parameters.
RemoveTangents
Removes a Tangents field in the vertices. (Field name: "Tangents0" - "Tangents255" & "Bitangents0" - "Bitangents255", Tuple size: 3 , Stored as: Vertex attribute)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the tangent fields to remove. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the tangent fields to remove. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| level | int | | | The level of the tangent fields to remove. |
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the texcoord field to remove. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | level | | | The level of the texcoord field to remove. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| level | int | | | The level of the texcoord field to remove. |
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Name of the field to be removed. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Name of the field to be removed. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Name of the field to be removed. |
RemoveUserVertexField
Removes a user-specified vertex field.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | The name of the field that is to be removed. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | The name of the field that is to be removed. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | The name of the field that is to be removed. |
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)
Syntax
Parameters
RemoveVertexLocks takes no parameters.
Syntax
Parameters
RemoveVertexLocks takes no parameters.
Syntax
Parameters
RemoveVertexLocks takes no parameters.
RemoveVertexWeighting
Removes the VertexWeighting field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)
Syntax
Parameters
RemoveVertexWeighting takes no parameters.
Syntax
Parameters
RemoveVertexWeighting takes no parameters.
Syntax
Parameters
RemoveVertexWeighting takes no parameters.
RemoveVertexWeights
Removes the VertexWeights field for the vertices. (Field name: "VertexWeights", Tuple size: 1 , Stored as: Vertex attribute)
Syntax
Parameters
RemoveVertexWeights takes no parameters.
Syntax
Parameters
RemoveVertexWeights takes no parameters.
Syntax
Parameters
RemoveVertexWeights takes no parameters.
SetInf
The inferior (minimum) extent of the geometry.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
RealData | vec | | | The desired values that the minimum extent of the geometry is to be set to. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
float[] | vec | | | The desired values that the minimum extent of the geometry is to be set to. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| vec | float | | | The desired values that the minimum extent of the geometry is to be set to. |
SetSup
The superior (maximum) extent of the geometry.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
RealData | vec | | | The desired values that the maximum extent of the geometry is to be set to. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
float[] | vec | | | The desired values that the maximum extent of the geometry is to be set to. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| vec | float | | | The desired values that the maximum extent of the geometry is to be set to. |
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: PackedGeometryData
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: PackedGeometryData
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: PackedGeometryData
