This is the documentation for Enlighten.

class Enlighten SourceMeshInstanceMeta

class Enlighten::SourceMeshInstanceMeta

Public interface for querying metadata of a single source mesh instance.

These are the meshes originally provided to Forge from Max/Maya and should be matched up with your game engine meshes using the GUID (which is also available in Max/Maya).

Functions

Name Description
GetGeom()

Gets the Geom which this SourceMeshInstance is associated with.

GetGeomMesh()

Gets the Geom Mesh this SourceMeshInstance is associated with.

GetGuid()

Gets the GUID of this SourceMeshInstance.

GetInstanceGuid()

Gets the Instance which this SourceMeshInstance belongs to.

GetInstancePrecompId()

Gets the precomp ID of the Instance that this SourceMeshInstance belongs to.

GetLightingType()

Gets the lighting type of this SourceMeshInstance.

GetSystem()

Gets the system that this SourceMeshInstance belongs to.

IsValid()

Some accessors return an 'invalid' object to represent nothing or not-found.


GeomMeta Enlighten::SourceMeshInstanceMeta::GetGeom


public: GeomMeta GetGeom() const


Gets the Geom which this SourceMeshInstance is associated with.

This can be used for retrieving the lightmap UVs for this mesh from the IPrecompPackedGeoemtry object. May return an 'Invalid' GeomMeta if this is a movable probe-lit mesh and so is not associated with a Geom.


GeomMeshMeta Enlighten::SourceMeshInstanceMeta::GetGeomMesh


public: GeomMeshMeta GetGeomMesh() const


Gets the Geom Mesh this SourceMeshInstance is associated with.

This can be used for retrieving the lightmap UVs for this mesh from the IPrecompPackedGeoemtry object. May return an 'Invalid' GeomMeshMeta if this is a movable probe-lit mesh and so is not associated with a Geom Mesh.


const Geo::GeoGuid& Enlighten::SourceMeshInstanceMeta::GetGuid


public: const Geo::GeoGuid & GetGuid() const


Gets the GUID of this SourceMeshInstance.


const Geo::GeoGuid& Enlighten::SourceMeshInstanceMeta::GetInstanceGuid


public: const Geo::GeoGuid & GetInstanceGuid() const


Gets the Instance which this SourceMeshInstance belongs to.

This can be used for retrieving the lightmap UV transform for this mesh from the IPrecompPackedSystem object. May be GeoGuid::Invalid if this is a movable probe-lit mesh and so does not belong to an Instance.


Geo::s32 Enlighten::SourceMeshInstanceMeta::GetInstancePrecompId


public: Geo::s32 GetInstancePrecompId() const


Gets the precomp ID of the Instance that this SourceMeshInstance belongs to.


eMetaLightingType::Value Enlighten::SourceMeshInstanceMeta::GetLightingType


public: eMetaLightingType::Value GetLightingType() const


Gets the lighting type of this SourceMeshInstance.


SystemMeta Enlighten::SourceMeshInstanceMeta::GetSystem


public: SystemMeta GetSystem() const


Gets the system that this SourceMeshInstance belongs to.


bool Enlighten::SourceMeshInstanceMeta::IsValid


public: bool IsValid() const


Some accessors return an 'invalid' object to represent nothing or not-found.