Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

class Enlighten::IPrecompSystemDependencies

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

Handle to the SystemDependencies.

Functions

NameDescription
AddSystemDependency(const char *, const Geo::GeoGuid &)

Adds a manual dependency on the specified system.

Create()

Create a new empty IPrecompSystemDependencies to load data into.

Create(const Geo::GeoGuid &)

Create a new IPrecompSystemDependencies for the specified system.

Create(const Geo::GeoGuid &, const IPrecompSystemDependencies *const *, Geo::s32)

Create a new IPrecompSystemDependencies as a union of the specified IPrecompSystemDependencies objects.

GetBoundingBoxDistance(Geo::s32)

Returns the distance from entity's bounding box to system at idx bounding box.

GetId()

Return the unique ID of this system.

GetMinimumDistance(Geo::s32)

Returns the minimum distance to system at idx. Determined by the shortest ray cast from this system that hit the target.

GetNumSystemDependencies()

Returns the number of systems known about in this class.

GetSystemId(Geo::s32)

Returns the system ID of entry idx.

GetSystemName(Geo::s32)

Returns the system name of entry idx.

GetVisibility(Geo::s32)

Returns the visibility of entry idx (as a proportion of the rays cast).

IsLocal(Geo::s32)

Returns the true is system at idx is physically close (used for locality based dependencies)

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.


Anchor
a3d0ad497abc6bcd23c92a26de00a740b
a3d0ad497abc6bcd23c92a26de00a740b

virtual void Enlighten::IPrecompSystemDependencies::AddSystemDependency

...

public: void AddSystemDependency
(
    const char * name,
    const Geo::GeoGuid & id
)

...

Adds a manual dependency on the specified system.


Anchor
ab36f67d2cea87b0a04623da8441eb2e5
ab36f67d2cea87b0a04623da8441eb2e5

static IPrecompSystemDependencies* Enlighten::IPrecompSystemDependencies::Create

...

public: IPrecompSystemDependencies * Create()

...

Create a new empty IPrecompSystemDependencies to load data into.


Anchor
a106aadf16344314435e6bae05d5fe757
a106aadf16344314435e6bae05d5fe757

static IPrecompSystemDependencies* Enlighten::IPrecompSystemDependencies::Create

...

public: IPrecompSystemDependencies * Create
(
    const Geo::GeoGuid & id
)

...

Create a new IPrecompSystemDependencies for the specified system.


Anchor
a7b45d98e6cf7ebec7d952cb066d6ded9
a7b45d98e6cf7ebec7d952cb066d6ded9

static IPrecompSystemDependencies* Enlighten::IPrecompSystemDependencies::Create

...

public: IPrecompSystemDependencies * Create
(
    const Geo::GeoGuid & id,
    const IPrecompSystemDependencies *const * others,
    Geo::s32 count
)

...

Create a new IPrecompSystemDependencies as a union of the specified IPrecompSystemDependencies objects.


Anchor
ad98bf2811a834c05af185b995cd5fe1d
ad98bf2811a834c05af185b995cd5fe1d

virtual float Enlighten::IPrecompSystemDependencies::GetBoundingBoxDistance

...

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

...

Returns the distance from entity's bounding box to system at idx bounding box.


Anchor
a7fa8005d79e5dc43700980973e41d8c1
a7fa8005d79e5dc43700980973e41d8c1

virtual Geo::GeoGuid Enlighten::IPrecompSystemDependencies::GetId

...

public: Geo::GeoGuid GetId() const

...

Return the unique ID of this system.


Anchor
adf4e19107ffa7f6c71681fee2579ec0e
adf4e19107ffa7f6c71681fee2579ec0e

virtual float Enlighten::IPrecompSystemDependencies::GetMinimumDistance

...

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

...

Returns the minimum distance to system at idx. Determined by the shortest ray cast from this system that hit the target.


Anchor
a7b01337ee7f186b92d233720387bf2f9
a7b01337ee7f186b92d233720387bf2f9

virtual Geo::s32 Enlighten::IPrecompSystemDependencies::GetNumSystemDependencies

...

public: Geo::s32 GetNumSystemDependencies() const

...

Returns the number of systems known about in this class.


Anchor
ab958837a74669e31eeffcc523a0f19e3
ab958837a74669e31eeffcc523a0f19e3

virtual Geo::GeoGuid Enlighten::IPrecompSystemDependencies::GetSystemId

...

public: Geo::GeoGuid GetSystemId
(
    Geo::s32 idx
) const

...

Returns the system ID of entry idx.


Anchor
a03f0d67809169b24781ec5d21371e9d2
a03f0d67809169b24781ec5d21371e9d2

virtual const char* Enlighten::IPrecompSystemDependencies::GetSystemName

...

public: const char * GetSystemName
(
    Geo::s32 idx
) const

...

Returns the system name of entry idx.


Anchor
a9f7acb13ace832ebcb717906cdecdf64
a9f7acb13ace832ebcb717906cdecdf64

virtual float Enlighten::IPrecompSystemDependencies::GetVisibility

...

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

...

Returns the visibility of entry idx (as a proportion of the rays cast).


Anchor
a0b366b67d0eadc1a3e8209614b24b227
a0b366b67d0eadc1a3e8209614b24b227

virtual bool Enlighten::IPrecompSystemDependencies::IsLocal

...

public: bool IsLocal
(
    Geo::s32 idx
) const

...

Returns the true is system at idx is physically close (used for locality based dependencies)


Anchor
ae5fb810c8f4470cb3c9fcb16c6f7f7fe
ae5fb810c8f4470cb3c9fcb16c6f7f7fe

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.


Anchor
af6bdf30b42adde386c428e9dc2821eb9
af6bdf30b42adde386c428e9dc2821eb9

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)'


Anchor
a5b03439626a3dac9b9c27feb1a3978d3
a5b03439626a3dac9b9c27feb1a3978d3

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.