Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

class Enlighten::IPrecompPackedInstance

Handle to the PackedInstance.

Functions

NameDescription
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.


Anchor
a9c81c822d700d38eb9d0634ead7921ce
a9c81c822d700d38eb9d0634ead7921ce

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.


Anchor
acbaf94360e5cece675d24139cbd960bd
acbaf94360e5cece675d24139cbd960bd

virtual Geo::GeoGuid Enlighten::IPrecompPackedInstance::GetGeometryId

...

public: Geo::GeoGuid GetGeometryId() const

...

Get the Geometry ID of this instance.


Anchor
a8e8bcba10d807bc1109b0b5bed711520
a8e8bcba10d807bc1109b0b5bed711520

virtual Geo::GeoGuid Enlighten::IPrecompPackedInstance::GetInstanceGuid

...

public: Geo::GeoGuid GetInstanceGuid() const

...

Get the original user-set GUID of this instance.


Anchor
ac12d5c54e7bcd27338b2f0815409d38a
ac12d5c54e7bcd27338b2f0815409d38a

virtual Geo::s32 Enlighten::IPrecompPackedInstance::GetInstanceId

...

public: Geo::s32 GetInstanceId() const

...

Get the original ID of this instance.


Anchor
ab6697f20697c274111d83788e6c537af
ab6697f20697c274111d83788e6c537af

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.


Anchor
a4be08f0ef3a5972daf22cadf92bda005
a4be08f0ef3a5972daf22cadf92bda005

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.


Anchor
af936353c680b550070843230aa82d500
af936353c680b550070843230aa82d500

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.


Anchor
a298313a199db5d69bbd4a02c7d2c55bc
a298313a199db5d69bbd4a02c7d2c55bc

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.


Anchor
a598852e3a6c67b44a8d339465ea59c09
a598852e3a6c67b44a8d339465ea59c09

virtual float Enlighten::IPrecompPackedInstance::GetProjectionCost

...

public: float GetProjectionCost() const

...

Gets the total projection cost over all meshes.


Anchor
a51e020d69269ed73db92995d1e2708fb
a51e020d69269ed73db92995d1e2708fb

virtual float Enlighten::IPrecompPackedInstance::GetProjectionCost

...

public: float GetProjectionCost
(
    Geo::s32 meshIdx
) const

...

Gets the projection cost for the given mesh.


Anchor
a47e1d7263860d413c811c2e5ab8b7b59
a47e1d7263860d413c811c2e5ab8b7b59

virtual Geo::Geo2DTransform Enlighten::IPrecompPackedInstance::GetUvTransform

...

public: Geo::Geo2DTransform GetUvTransform() const

...

Get per-instance 2d UV packed-instance to packed-system transform.