This is the documentation for Enlighten.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

class Enlighten::IPrecompSystemCompressedLightTransport

    └>Geo::IGeoSerialisable
        └>Geo::IGeoReleasable

Handle to a compressed SystemLightTransport.

Functions

Name Description
Create()

Create a new empty IPrecompSystemCompressedLightTransport to load data into.

GetBuildParameters()

Get the build parameters this system was built with.

GetId()

Return the unique ID of this system.

GetLod(Geo::s32)

Access the IPrecompSystemCompressedLightTransport representing the LOD version of the system. GetLod(0) will return the pointer to the main system (i.e. this system)

GetName()

Get the full name.

GetNumLods()

For systems with no LODs generated GetNumLods will return 1 (i.e. the main system is considered to be the first LOD)

Load(IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoInputStream.

Release()

Free this object that was created within the Enlighten libraries.

Save(IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.


static IPrecompSystemCompressedLightTransport* Enlighten::IPrecompSystemCompressedLightTransport::Create


public: IPrecompSystemCompressedLightTransport * Create()


Create a new empty IPrecompSystemCompressedLightTransport to load data into.


virtual const IPrecompBuildParameters* Enlighten::IPrecompSystemCompressedLightTransport::GetBuildParameters


public: const IPrecompBuildParameters * GetBuildParameters() const


Get the build parameters this system was built with.


virtual Geo::GeoGuid Enlighten::IPrecompSystemCompressedLightTransport::GetId


public: Geo::GeoGuid GetId() const


Return the unique ID of this system.


virtual const IPrecompSystemCompressedLightTransport* Enlighten::IPrecompSystemCompressedLightTransport::GetLod


public: const IPrecompSystemCompressedLightTransport * GetLod
(
    Geo::s32 lodIndex
) const


Access the IPrecompSystemCompressedLightTransport representing the LOD version of the system. GetLod(0) will return the pointer to the main system (i.e. this system)


virtual const char* Enlighten::IPrecompSystemCompressedLightTransport::GetName


public: const char * GetName() const


Get the full name.


virtual Geo::s32 Enlighten::IPrecompSystemCompressedLightTransport::GetNumLods


public: Geo::s32 GetNumLods() const


For systems with no LODs generated GetNumLods will return 1 (i.e. the main system is considered to be the first 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 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 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.

  • No labels