This is the documentation for Enlighten.
class Enlighten IPrecompPackedInstance
class Enlighten::IPrecompPackedInstance
Handle to the PackedInstance.
Functions
| Name | Description |
|---|---|
| GetClusterSize() | Returns system's cluster size override for this instance. |
| GetGeometryId() | Get the Geometry ID of this instance. |
| GetInstanceGuid() | Get the original user-set GUID of this instance. |
| GetInstanceId() | Get the original ID of this instance. |
| GetInstanceIdx() | Get the original ID of this instance. |
| GetNumMeshes() | Gets the number of meshes that were in the geometry object this instance was built from. |
| GetNumVerts(Geo::s32) | Returns the number of vertices for the mesh at index meshIdx. |
| GetOutputUvArray(Geo::s32) | Returns a pointer to the per-vertex uvs for the mesh at index meshIdx. |
| GetProjectionCost() | Gets the total projection cost over all meshes. |
| GetProjectionCost(Geo::s32) | Gets the projection cost for the given mesh. |
| GetUvTransform() | Get per-instance 2d UV packed-instance to packed-system transform. |
virtual float Enlighten::IPrecompPackedInstance::GetClusterSize
public: float GetClusterSize() const
Returns system's cluster size override for this instance.
If non-negative, this specifies a per-instance cluster size, overriding the value set for the system to which this instance belongs.
Returns
system's cluster size override for this instance.
virtual Geo::GeoGuid Enlighten::IPrecompPackedInstance::GetGeometryId
public: Geo::GeoGuid GetGeometryId() const
Get the Geometry ID of this instance.
virtual Geo::GeoGuid Enlighten::IPrecompPackedInstance::GetInstanceGuid
public: Geo::GeoGuid GetInstanceGuid() const
Get the original user-set GUID of this instance.
virtual Geo::s32 Enlighten::IPrecompPackedInstance::GetInstanceId
public: Geo::s32 GetInstanceId() const
Get the original ID of this instance.
virtual Geo::s32 Enlighten::IPrecompPackedInstance::GetInstanceIdx
public: virtual Geo::s32 GetInstanceIdx() const
Get the original ID of this instance.
Deprecated
Please use GetInstanceId() instead, which returns the same value but is more accurately named.
virtual Geo::s32 Enlighten::IPrecompPackedInstance::GetNumMeshes
public: Geo::s32 GetNumMeshes() const
Gets the number of meshes that were in the geometry object this instance was built from.
virtual Geo::s32 Enlighten::IPrecompPackedInstance::GetNumVerts
public: Geo::s32 GetNumVerts
(
Geo::s32 meshIdx
) const
Returns the number of vertices for the mesh at index meshIdx.
Parameters
| [in] | meshIdx | This should be a valid index between [0, GetNumMeshes()-1]. |
Returns
The number of verts or -1 if the meshIdx is invalid.
virtual const Geo::GeoPoint2* Enlighten::IPrecompPackedInstance::GetOutputUvArray
public: const Geo::GeoPoint2 * GetOutputUvArray
(
Geo::s32 meshIdx
) const
Returns a pointer to the per-vertex uvs for the mesh at index meshIdx.
Parameters
| [in] | meshIdx | This should be a valid index between [0, GetNumMeshes()-1]. |
Returns
A const pointer to an array of uvs or NULL if the meshIdx is invalid.
virtual float Enlighten::IPrecompPackedInstance::GetProjectionCost
public: float GetProjectionCost() const
Gets the total projection cost over all meshes.
virtual float Enlighten::IPrecompPackedInstance::GetProjectionCost
public: float GetProjectionCost
(
Geo::s32 meshIdx
) const
Gets the projection cost for the given mesh.
virtual Geo::Geo2DTransform Enlighten::IPrecompPackedInstance::GetUvTransform
public: Geo::Geo2DTransform GetUvTransform() const
Get per-instance 2d UV packed-instance to packed-system transform.