This is the documentation for Enlighten.

class Enlighten SystemDataBlock

class Enlighten::SystemDataBlock

    └>Enlighten::IPrecomputeLoaderSystem
        └>Geo::IGeoSerialisable
            └>Geo::IGeoReleasable

A System data Block which contains the precompute data required by Enlighten at runtime.

Functions

Name Description
Create()

Create an empty object.

Create()

Create an empty object.

FreeData(Geo::u32)

Free memory data of a optional section.

FreeData(Geo::u32)

Free memory data of a optional section.

GetClusterAlbedoWorkspace()

Get cluster albedo workspace.

GetClusterAlbedoWorkspace()

Get cluster albedo workspace.

GetHeight(Geo::s32)

Get lightmap height at given lod.

GetHeight(Geo::s32)

Get lightmap height at given lod.

GetId()

Get system id.

GetId()

Get system id.

GetInputWorkspace()

Get input workspace.

GetInputWorkspace()

Get input workspace.

GetLodCount()

Get number of system lod's.

GetLodCount()

Get number of system lod's.

GetPrecomputedVisibility()

Get precomputed visibility.

GetPrecomputedVisibility()

Get precomputed visibility.

GetRadiosityCore(Geo::s32)

Get radiosity core at given lod.

GetRadiosityCore(Geo::s32)

Get radiosity core at given lod.

GetRadiosityNormalTexHeight(Geo::s32)

Get radiosity normal texture height at given lod.

GetRadiosityNormalTexHeight(Geo::s32)

Get radiosity normal texture height at given lod.

GetRadiosityNormalTexPixels(Geo::s32)

Get radiosity normal texture pixels at given lod The pixels are stored linearly in a contiguous array.

GetRadiosityNormalTexPixels(Geo::s32)

Get radiosity normal texture pixels at given lod The pixels are stored linearly in a contiguous array.

GetRadiosityNormalTexWidth(Geo::s32)

Get radiosity normal texture width at given lod.

GetRadiosityNormalTexWidth(Geo::s32)

Get radiosity normal texture width at given lod.

GetSystemDependenciesCount()

Get number of system dependencies.

GetSystemDependenciesCount()

Get number of system dependencies.

GetSystemDependency(Geo::s32)

Get dependency system id at index idx.

GetSystemDependency(Geo::s32)

Get dependency system id at index idx.

GetUvTransform(Geo::s32, Geo::s32)

Get uv transform for instance idx at given lod.

GetUvTransform(Geo::s32, Geo::s32)

Get uv transform for instance idx at given lod.

GetUvTransformsCount()

Get number of uv transforms per lod, which equals the number of instances in the system.

GetUvTransformsCount()

Get number of uv transforms per lod, which equals the number of instances in the system.

GetWidth(Geo::s32)

Get lightmap width at given lod.

GetWidth(Geo::s32)

Get lightmap width at given lod.

Load(IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoInputStream.

Load(Geo::IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoInputStream.

Release()

Free this object that was created within the Enlighten libraries.

Release()

Free this object that was created within the Enlighten libraries.

Save(IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.

Save(Geo::IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.


static SystemDataBlock* Enlighten::SystemDataBlock::Create


public: SystemDataBlock * Create()


Create an empty object.


static IPrecomputeLoaderSystem* Enlighten::IPrecomputeLoaderSystem::Create


public: IPrecomputeLoaderSystem * Create()


Create an empty object.


virtual void Enlighten::IPrecomputeLoaderSystem::FreeData


public: void FreeData
(
    Geo::u32 section
)


Free memory data of a optional section.


virtual void Enlighten::SystemDataBlock::FreeData


public: virtual void FreeData
(
    Geo::u32 section
)


Free memory data of a optional section.


virtual const Enlighten::ClusterAlbedoWorkspaceMaterialData* Enlighten::SystemDataBlock::GetClusterAlbedoWorkspace


public: virtual const Enlighten::ClusterAlbedoWorkspaceMaterialData * GetClusterAlbedoWorkspace() const


Get cluster albedo workspace.


virtual const Enlighten::ClusterAlbedoWorkspaceMaterialData* Enlighten::IPrecomputeLoaderSystem::GetClusterAlbedoWorkspace


public: const Enlighten::ClusterAlbedoWorkspaceMaterialData * GetClusterAlbedoWorkspace() const


Get cluster albedo workspace.


virtual Geo::s32 Enlighten::SystemDataBlock::GetHeight


public: virtual Geo::s32 GetHeight
(
    Geo::s32 lod
) const


Get lightmap height at given lod.


virtual Geo::s32 Enlighten::IPrecomputeLoaderSystem::GetHeight


public: Geo::s32 GetHeight
(
    Geo::s32 lod
) const


Get lightmap height at given lod.


virtual const Geo::GeoGuid& Enlighten::SystemDataBlock::GetId


public: virtual const Geo::GeoGuid & GetId() const


Get system id.


virtual const Geo::GeoGuid& Enlighten::IPrecomputeLoaderSystem::GetId


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


Get system id.


virtual const Enlighten::InputWorkspace* Enlighten::SystemDataBlock::GetInputWorkspace


public: virtual const Enlighten::InputWorkspace * GetInputWorkspace() const


Get input workspace.


virtual const Enlighten::InputWorkspace* Enlighten::IPrecomputeLoaderSystem::GetInputWorkspace


public: const Enlighten::InputWorkspace * GetInputWorkspace() const


Get input workspace.


virtual Geo::s32 Enlighten::SystemDataBlock::GetLodCount


public: virtual Geo::s32 GetLodCount() const


Get number of system lod's.


virtual Geo::s32 Enlighten::IPrecomputeLoaderSystem::GetLodCount


public: Geo::s32 GetLodCount() const


Get number of system lod's.


virtual const Enlighten::PrecomputedVisibilityData* Enlighten::SystemDataBlock::GetPrecomputedVisibility


public: virtual const Enlighten::PrecomputedVisibilityData * GetPrecomputedVisibility() const


Get precomputed visibility.


virtual const Enlighten::PrecomputedVisibilityData* Enlighten::IPrecomputeLoaderSystem::GetPrecomputedVisibility


public: const Enlighten::PrecomputedVisibilityData * GetPrecomputedVisibility() const


Get precomputed visibility.


virtual const Enlighten::RadSystemCore* Enlighten::IPrecomputeLoaderSystem::GetRadiosityCore


public: const Enlighten::RadSystemCore * GetRadiosityCore
(
    Geo::s32 lod
) const


Get radiosity core at given lod.


virtual const Enlighten::RadSystemCore* Enlighten::SystemDataBlock::GetRadiosityCore


public: virtual const Enlighten::RadSystemCore * GetRadiosityCore
(
    Geo::s32 lod
) const


Get radiosity core at given lod.


virtual Geo::s32 Enlighten::IPrecomputeLoaderSystem::GetRadiosityNormalTexHeight


public: Geo::s32 GetRadiosityNormalTexHeight
(
    Geo::s32 lod
) const


Get radiosity normal texture height at given lod.


virtual Geo::s32 Enlighten::SystemDataBlock::GetRadiosityNormalTexHeight


public: virtual Geo::s32 GetRadiosityNormalTexHeight
(
    Geo::s32 lod
) const


Get radiosity normal texture height at given lod.


virtual const Geo::GeoRGBXTextureElement* Enlighten::IPrecomputeLoaderSystem::GetRadiosityNormalTexPixels


public: const Geo::GeoRGBXTextureElement * GetRadiosityNormalTexPixels
(
    Geo::s32 lod
) const


Get radiosity normal texture pixels at given lod The pixels are stored linearly in a contiguous array.


virtual const Geo::GeoRGBXTextureElement* Enlighten::SystemDataBlock::GetRadiosityNormalTexPixels


public: virtual const Geo::GeoRGBXTextureElement * GetRadiosityNormalTexPixels
(
    Geo::s32 lod
) const


Get radiosity normal texture pixels at given lod The pixels are stored linearly in a contiguous array.


virtual Geo::s32 Enlighten::SystemDataBlock::GetRadiosityNormalTexWidth


public: virtual Geo::s32 GetRadiosityNormalTexWidth
(
    Geo::s32 lod
) const


Get radiosity normal texture width at given lod.


virtual Geo::s32 Enlighten::IPrecomputeLoaderSystem::GetRadiosityNormalTexWidth


public: Geo::s32 GetRadiosityNormalTexWidth
(
    Geo::s32 lod
) const


Get radiosity normal texture width at given lod.


virtual Geo::s32 Enlighten::IPrecomputeLoaderSystem::GetSystemDependenciesCount


public: Geo::s32 GetSystemDependenciesCount() const


Get number of system dependencies.


virtual Geo::s32 Enlighten::SystemDataBlock::GetSystemDependenciesCount


public: virtual Geo::s32 GetSystemDependenciesCount() const


Get number of system dependencies.


virtual const Geo::GeoGuid& Enlighten::IPrecomputeLoaderSystem::GetSystemDependency


public: const Geo::GeoGuid & GetSystemDependency
(
    Geo::s32 idx
) const


Get dependency system id at index idx.


virtual const Geo::GeoGuid& Enlighten::SystemDataBlock::GetSystemDependency


public: virtual const Geo::GeoGuid & GetSystemDependency
(
    Geo::s32 idx
) const


Get dependency system id at index idx.


virtual const Geo::Geo2DTransform& Enlighten::IPrecomputeLoaderSystem::GetUvTransform


public: const Geo::Geo2DTransform & GetUvTransform
(
    Geo::s32 lod,
    Geo::s32 idx
) const


Get uv transform for instance idx at given lod.


virtual const Geo::Geo2DTransform& Enlighten::SystemDataBlock::GetUvTransform


public: virtual const Geo::Geo2DTransform & GetUvTransform
(
    Geo::s32 lod,
    Geo::s32 idx
) const


Get uv transform for instance idx at given lod.


virtual Geo::s32 Enlighten::IPrecomputeLoaderSystem::GetUvTransformsCount


public: Geo::s32 GetUvTransformsCount() const


Get number of uv transforms per lod, which equals the number of instances in the system.


virtual Geo::s32 Enlighten::SystemDataBlock::GetUvTransformsCount


public: virtual Geo::s32 GetUvTransformsCount() const


Get number of uv transforms per lod, which equals the number of instances in the system.


virtual Geo::s32 Enlighten::SystemDataBlock::GetWidth


public: virtual Geo::s32 GetWidth
(
    Geo::s32 lod
) const


Get lightmap width at given lod.


virtual Geo::s32 Enlighten::IPrecomputeLoaderSystem::GetWidth


public: Geo::s32 GetWidth
(
    Geo::s32 lod
) const


Get lightmap width at given lod.


virtual bool Geo::IGeoSerialisable::Load


public: bool Load
(
    IGeoInputStream & stream,
    Geo::u32 section
)


Load an instance of this class from an IGeoInputStream.

The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.


virtual bool Enlighten::SystemDataBlock::Load


public: virtual bool Load
(
    Geo::IGeoInputStream & stream,
    Geo::u32 section
)


Load an instance of this class from an IGeoInputStream.

The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.


virtual void Geo::IGeoReleasable::Release


public: void Release()


Free this object that was created within the Enlighten libraries.

Expect this to behave in a similar way to calling 'delete(this)'


virtual void Enlighten::SystemDataBlock::Release


public: virtual void Release()


Free this object that was created within the Enlighten libraries.

Expect this to behave in a similar way to calling 'delete(this)'


virtual bool Geo::IGeoSerialisable::Save


public: bool Save
(
    IGeoStream & stream,
    Geo::u32 section
) const


Save an instance of this class to an IGeoStream.

The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.


virtual bool Enlighten::SystemDataBlock::Save


public: virtual bool Save
(
    Geo::IGeoStream & stream,
    Geo::u32 section
) const


Save an instance of this class to an IGeoStream.

The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.