This is the documentation for Enlighten.
class Enlighten IPrecompSystemDependencies
- William Joseph
- geosw (Unlicensed)
class Enlighten::IPrecompSystemDependencies
└>Geo::IGeoSerialisable
└>Geo::IGeoReleasable
Handle to the SystemDependencies.
Functions
| Name | Description |
|---|---|
| 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. |
| 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. |
virtual void Enlighten::IPrecompSystemDependencies::AddSystemDependency
public: void AddSystemDependency
(
const char * name,
const Geo::GeoGuid & id
)
Adds a manual dependency on the specified system.
static IPrecompSystemDependencies* Enlighten::IPrecompSystemDependencies::Create
public: IPrecompSystemDependencies * Create()
Create a new empty IPrecompSystemDependencies to load data into.
static IPrecompSystemDependencies* Enlighten::IPrecompSystemDependencies::Create
public: IPrecompSystemDependencies * Create
(
const Geo::GeoGuid & id
)
Create a new IPrecompSystemDependencies for the specified system.
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.
virtual Geo::GeoGuid Enlighten::IPrecompSystemDependencies::GetId
public: Geo::GeoGuid GetId() const
Return the unique ID of this system.
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.
virtual Geo::s32 Enlighten::IPrecompSystemDependencies::GetNumSystemDependencies
public: Geo::s32 GetNumSystemDependencies() const
Returns the number of systems known about in this class.
virtual Geo::GeoGuid Enlighten::IPrecompSystemDependencies::GetSystemId
public: Geo::GeoGuid GetSystemId
(
Geo::s32 idx
) const
Returns the system ID of entry idx.
virtual const char* Enlighten::IPrecompSystemDependencies::GetSystemName
public: const char * GetSystemName
(
Geo::s32 idx
) const
Returns the system name of entry idx.
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).
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)
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.