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::IPrecompGeneratedSystems

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

Result of the the IPrecompute::CreateSystemsByVoxelisation() call.

Functions

Name Description
Create()

Create a new empty IPrecompGeneratedSystems to fill with data.

GetBoundingBox(Geo::s32)

Returns the bounding box of the system with index idx.

GetMinOutputPixelSize(Geo::s32)

Returns the minimum output pixel size of the instances in the system with index idx.

GetNumSystems()

Return the number of systems created.

GetSystem(Geo::s32)

Returns the system grouping.

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 IPrecompGeneratedSystems* Enlighten::IPrecompGeneratedSystems::Create


public: IPrecompGeneratedSystems * Create()


Create a new empty IPrecompGeneratedSystems to fill with data.


virtual const Geo::GeoBoundingBox& Enlighten::IPrecompGeneratedSystems::GetBoundingBox


public: const Geo::GeoBoundingBox & GetBoundingBox
(
    Geo::s32 idx
) const


Returns the bounding box of the system with index idx.


virtual float Enlighten::IPrecompGeneratedSystems::GetMinOutputPixelSize


public: float GetMinOutputPixelSize
(
    Geo::s32 idx
) const


Returns the minimum output pixel size of the instances in the system with index idx.


virtual Geo::s32 Enlighten::IPrecompGeneratedSystems::GetNumSystems


public: Geo::s32 GetNumSystems() const


Return the number of systems created.


virtual const IPrecompInputSystem* Enlighten::IPrecompGeneratedSystems::GetSystem


public: const IPrecompInputSystem * GetSystem
(
    Geo::s32 idx
) const


Returns the system grouping.

The instances will have the original m_Id member, which should be used to match them to the instance list used to create IPrecompInputSystem passed in as input to the IPrecompute::CreateSystemsByVoxelisation() call.


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