This is the documentation for Enlighten.
class Enlighten MetaBlock
- William Joseph
class Enlighten::MetaBlock
A compact block of Enlighten scene metadata providing efficient queries.
This object consists of a 'header', which is the normal C++ object, and a 'payload' which is allocated directly after the header.
Usage:
Acquire this object by building the block from an Enlighten3MetaBuilder/MetaBlockBuilder, or by loading a previously serialised block. This can be done using the utility functions in MetaUtils.h.
Query the metadata using the GetXXX() methods.
Functions
| Name | Description |
|---|---|
| GetCubeMap(Geo::s32) | Access to the collections of objects. |
| GetCubeMap(const Geo::GeoGuid &) | Access to the collections of objects. |
| GetDirectionalLight(const Geo::GeoGuid &) | Access to the collections of objects. |
| GetDirectionalLight(Geo::s32) | Access to the collections of objects. |
| GetEnvironmentLight(Geo::s32) | Access to the collections of objects. |
| GetEnvironmentLight(const Geo::GeoGuid &) | Access to the collections of objects. |
| GetGeom(Geo::s32) | Access to the collections of objects. |
| GetGeom(const Geo::GeoGuid &) | Access to the collections of objects. |
| GetGeomMesh(Geo::s32) | Access to the collections of objects. |
| GetGeomMesh(const Geo::GeoGuid &) | Access to the collections of objects. |
| GetNumCubeMaps() | Access to the collections of objects. |
| GetNumDirectionalLights() | Access to the collections of objects. |
| GetNumEnvironmentLights() | Access to the collections of objects. |
| GetNumGeomMeshes() | Access to the collections of objects. |
| GetNumGeoms() | Access to the collections of objects. |
| GetNumPointLights() | Access to the collections of objects. |
| GetNumProbeSets() | Access to the collections of objects. |
| GetNumSourceMeshInstances() | Access to the collections of objects. |
| GetNumSpotlights() | Access to the collections of objects. |
| GetNumSystems() | Access to the collections of objects. |
| GetPointLight(Geo::s32) | Access to the collections of objects. |
| GetPointLight(const Geo::GeoGuid &) | Access to the collections of objects. |
| GetProbeSet(Geo::s32) | Access to the collections of objects. |
| GetProbeSet(const Geo::GeoGuid &) | Access to the collections of objects. |
| GetSize() | Gets the total size of this MetaBlock (in bytes), including both the header and the payload. |
| GetSourceMeshInstance(const Geo::GeoGuid &) | Access to the collections of objects. |
| GetSourceMeshInstance(Geo::s32) | Access to the collections of objects. |
| GetSpotlight(Geo::s32) | Access to the collections of objects. |
| GetSpotlight(const Geo::GeoGuid &) | Access to the collections of objects. |
| GetSystem(const Geo::GeoGuid &) | Access to the collections of objects. |
| GetSystem(Geo::s32) | Access to the collections of objects. |
CubeMapMeta Enlighten::MetaBlock::GetCubeMap
public: CubeMapMeta GetCubeMap
(
Geo::s32 idx
) const
Access to the collections of objects.
CubeMapMeta Enlighten::MetaBlock::GetCubeMap
public: CubeMapMeta GetCubeMap
(
const Geo::GeoGuid & guid
) const
Access to the collections of objects.
DirectionalLightMeta Enlighten::MetaBlock::GetDirectionalLight
public: DirectionalLightMeta GetDirectionalLight
(
const Geo::GeoGuid & guid
) const
Access to the collections of objects.
DirectionalLightMeta Enlighten::MetaBlock::GetDirectionalLight
public: DirectionalLightMeta GetDirectionalLight
(
Geo::s32 idx
) const
Access to the collections of objects.
EnvironmentLightMeta Enlighten::MetaBlock::GetEnvironmentLight
public: EnvironmentLightMeta GetEnvironmentLight
(
Geo::s32 idx
) const
Access to the collections of objects.
EnvironmentLightMeta Enlighten::MetaBlock::GetEnvironmentLight
public: EnvironmentLightMeta GetEnvironmentLight
(
const Geo::GeoGuid & guid
) const
Access to the collections of objects.
GeomMeta Enlighten::MetaBlock::GetGeom
public: GeomMeta GetGeom
(
Geo::s32 idx
) const
Access to the collections of objects.
GeomMeta Enlighten::MetaBlock::GetGeom
public: GeomMeta GetGeom
(
const Geo::GeoGuid & guid
) const
Access to the collections of objects.
GeomMeshMeta Enlighten::MetaBlock::GetGeomMesh
public: GeomMeshMeta GetGeomMesh
(
Geo::s32 idx
) const
Access to the collections of objects.
GeomMeshMeta Enlighten::MetaBlock::GetGeomMesh
public: GeomMeshMeta GetGeomMesh
(
const Geo::GeoGuid & guid
) const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetNumCubeMaps
public: Geo::s32 GetNumCubeMaps() const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetNumDirectionalLights
public: Geo::s32 GetNumDirectionalLights() const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetNumEnvironmentLights
public: Geo::s32 GetNumEnvironmentLights() const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetNumGeomMeshes
public: Geo::s32 GetNumGeomMeshes() const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetNumGeoms
public: Geo::s32 GetNumGeoms() const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetNumPointLights
public: Geo::s32 GetNumPointLights() const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetNumProbeSets
public: Geo::s32 GetNumProbeSets() const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetNumSourceMeshInstances
public: Geo::s32 GetNumSourceMeshInstances() const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetNumSpotlights
public: Geo::s32 GetNumSpotlights() const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetNumSystems
public: Geo::s32 GetNumSystems() const
Access to the collections of objects.
PointLightMeta Enlighten::MetaBlock::GetPointLight
public: PointLightMeta GetPointLight
(
Geo::s32 idx
) const
Access to the collections of objects.
PointLightMeta Enlighten::MetaBlock::GetPointLight
public: PointLightMeta GetPointLight
(
const Geo::GeoGuid & guid
) const
Access to the collections of objects.
ProbeSetMeta Enlighten::MetaBlock::GetProbeSet
public: ProbeSetMeta GetProbeSet
(
Geo::s32 idx
) const
Access to the collections of objects.
ProbeSetMeta Enlighten::MetaBlock::GetProbeSet
public: ProbeSetMeta GetProbeSet
(
const Geo::GeoGuid & guid
) const
Access to the collections of objects.
Geo::s32 Enlighten::MetaBlock::GetSize
public: Geo::s32 GetSize() const
Gets the total size of this MetaBlock (in bytes), including both the header and the payload.
SourceMeshInstanceMeta Enlighten::MetaBlock::GetSourceMeshInstance
public: SourceMeshInstanceMeta GetSourceMeshInstance
(
const Geo::GeoGuid & guid
) const
Access to the collections of objects.
SourceMeshInstanceMeta Enlighten::MetaBlock::GetSourceMeshInstance
public: SourceMeshInstanceMeta GetSourceMeshInstance
(
Geo::s32 idx
) const
Access to the collections of objects.
SpotlightMeta Enlighten::MetaBlock::GetSpotlight
public: SpotlightMeta GetSpotlight
(
Geo::s32 idx
) const
Access to the collections of objects.
SpotlightMeta Enlighten::MetaBlock::GetSpotlight
public: SpotlightMeta GetSpotlight
(
const Geo::GeoGuid & guid
) const
Access to the collections of objects.
SystemMeta Enlighten::MetaBlock::GetSystem
public: SystemMeta GetSystem
(
const Geo::GeoGuid & guid
) const
Access to the collections of objects.
SystemMeta Enlighten::MetaBlock::GetSystem
public: SystemMeta GetSystem
(
Geo::s32 idx
) const
Access to the collections of objects.