Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Enlighten API 3.10 Documentation
Results will update as you type.
  • class Enlighten IPrecompSystemClustering
  • class Enlighten IPrecompSystemCompressedLightTransport
  • class Enlighten IPrecompSystemDependencies
  • class Enlighten IPrecompSystemDuster
  • class Enlighten IPrecompSystemLightTransport
  • class Enlighten IPrecompSystemPreClustering
  • class Enlighten IPrecompSystemRadiosity
  • class Enlighten IPrecompSystemsDependencies
  • class Enlighten IPrecompute
  • class Enlighten IPrecomputeLoaderCubeMap
  • class Enlighten IPrecomputeLoaderGeometry
  • class Enlighten IPrecomputeLoaderProbeSet
  • class Enlighten IPrecomputeLoaderSystem
  • class Enlighten IPrecompVolumeQuery
  • class Enlighten IProbeSetManager
  • class Enlighten IrradianceOutputDesc
  • class Enlighten ISystemSolutionSpace
  • class Enlighten IThreadGroup
  • class Enlighten IUpdateManager
  • class Enlighten IUpdateManagerWorker
  • class Enlighten IViewVolumeIntersector
  • class Enlighten LightMethodSelector
  • class Enlighten LightTransportPixel
  • class Enlighten LightValue64
  • class Enlighten LightValueIterator
  • class Enlighten Line2D
  • class Enlighten LongRunningProcess
  • class Enlighten LrbCpuTextureSampler
  • class Enlighten MaterialAlbedoSampler
  • class Enlighten MaterialComponentBuffer
  • class Enlighten MaterialEmissiveSampler
  • class Enlighten MaterialGuids
  • class Enlighten MaterialSampler
  • class Enlighten MaterialTransparencySampler
  • class Enlighten MergeGeometry
  • class Enlighten MergeGeometryCache
  • class Enlighten MergeMap
  • class Enlighten MergeProcessParams
  • class Enlighten MergeStats
  • class Enlighten MergeTriGroupParams
  • class Enlighten MetaBlock
  • class Enlighten MetaBlockBuilder
  • class Enlighten MultithreadCpuUpdateManager
  • class Enlighten MultithreadCpuWorker
  • class Enlighten MultithreadCpuWorkerCommon
  • class Enlighten NullGeometryTransparencySampler
  • class Enlighten NullMaterialEmissiveSampler
  • class Enlighten NullMaterialTransparencySampler
  • class Enlighten NullSampler
  • class Enlighten OctreeBuilder
  • class Enlighten OctreeSearchResult
  • class Enlighten OutputOctreeBuilder
  • class Enlighten PackedDusterPoint
  • class Enlighten PipelineCubemap
  • class Enlighten PipelineError
  • class Enlighten PipelineExcludedInstance
  • class Enlighten PipelineGeom
  • class Enlighten PipelineGeometryProperties
  • class Enlighten PipelineGlobalParameters
  • class Enlighten PipelineInstanceParameters
  • class Enlighten PipelineLineWriter
  • class Enlighten PipelineMesh
  • class Enlighten PipelinePaths
  • class Enlighten PipelineProbeRegion
  • class Enlighten PipelineProbeVolume
  • class Enlighten PipelineRadiosityInstance
  • class Enlighten PipelineScene
  • class Enlighten PipelineTransform
  • class Enlighten PointLight
  • class Enlighten PointLightMeta
  • class Enlighten PointProjection
  • class Enlighten PointProjectionOptions
  • class Enlighten PointProjectionScratchMem
  • class Enlighten PointProjectionSurface
  • class Enlighten PointProjectionVersion
  • class Enlighten PppiManager
  • class Enlighten PppiWorld
  • class Enlighten PrecompInputAutoProbeVolume
  • class Enlighten PrecompInputFace
  • class Enlighten PrecompInputInstance
  • class Enlighten PrecompInputOctreeBoxSet
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten MetaBlock

    This is the documentation for Enlighten.

    class Enlighten MetaBlock

    Nov 21, 2019

    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:

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

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

    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "f29b04caa00f4377984b64839e0d17c7"}