This is the documentation for Enlighten.
class Enlighten IPrecompOutputProbeOctree
- William Joseph
- geosw (Unlicensed)
class Enlighten::IPrecompOutputProbeOctree
└>Geo::IGeoSerialisable
└>Geo::IGeoReleasable
A class representing an octree which defines sets of probe positions within a volume.
Functions
| Name | Description |
|---|---|
| Create() | Create a new empty IPrecompOutputProbeOctree. |
| GetBuildParameters() | Read only access to the build parameters for this probe octree. |
| GetName() | Get the full name. |
| GetNumProbeSets() | The number of sets of probe positions generated from the octree. |
| GetSystemDependencies(Geo::s32) | Returns the system 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. |
static IPrecompOutputProbeOctree* Enlighten::IPrecompOutputProbeOctree::Create
public: IPrecompOutputProbeOctree * Create()
Create a new empty IPrecompOutputProbeOctree.
virtual const IPrecompProbeSetBuildParameters* Enlighten::IPrecompOutputProbeOctree::GetBuildParameters
public: const IPrecompProbeSetBuildParameters * GetBuildParameters() const
Read only access to the build parameters for this probe octree.
virtual const char* Enlighten::IPrecompOutputProbeOctree::GetName
public: const char * GetName() const
Get the full name.
virtual Geo::s32 Enlighten::IPrecompOutputProbeOctree::GetNumProbeSets
public: Geo::s32 GetNumProbeSets() const
The number of sets of probe positions generated from the octree.
virtual const IPrecompSystemDependencies* Enlighten::IPrecompOutputProbeOctree::GetSystemDependencies
public: const IPrecompSystemDependencies * GetSystemDependencies
(
Geo::s32 idx
) const
Returns the system 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.