class Enlighten::IPrecompInputCubeMap

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

A class representing a cube map object which the run-time can generate dynamically.

Functions

Name	Description
Create()	Create a new empty IPrecompInputCubeMap.
GetBuildParameters()	Edit the build parameters for this cube map.
GetBuildParameters()	Read only access to the build parameters for this cube map.
GetFaceWidth()	Get the width and length of face in the cube map.
GetId()	Return the unique ID of this cube map.
GetLocation()	Get the world space location of the cube map.
GetName()	Get the full name.
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.
SetFaceWidth(Geo::s32)	Set the width and length of face in the cube map.
SetId(Geo::GeoGuid)	Set the unique ID of this cube map.
SetLocation(const Geo::Matrix &)	Set the world space position and orientation of the cube map.
SetName(const char *)	Set a globally unique name.

static IPrecompInputCubeMap* Enlighten::IPrecompInputCubeMap::Create

public: IPrecompInputCubeMap * Create()

Create a new empty IPrecompInputCubeMap.

virtual IPrecompCubeMapBuildParameters* Enlighten::IPrecompInputCubeMap::GetBuildParameters

public: IPrecompCubeMapBuildParameters * GetBuildParameters()

Edit the build parameters for this cube map.

virtual const IPrecompCubeMapBuildParameters* Enlighten::IPrecompInputCubeMap::GetBuildParameters

public: const IPrecompCubeMapBuildParameters * GetBuildParameters() const

Read only access to the build parameters for this cube map.

virtual Geo::s32 Enlighten::IPrecompInputCubeMap::GetFaceWidth

public: Geo::s32 GetFaceWidth() const

Get the width and length of face in the cube map.

virtual Geo::GeoGuid Enlighten::IPrecompInputCubeMap::GetId

public: Geo::GeoGuid GetId() const

Return the unique ID of this cube map.

virtual const Geo::Matrix& Enlighten::IPrecompInputCubeMap::GetLocation

public: const Geo::Matrix & GetLocation() const

Get the world space location of the cube map.

Returns

The current location, or the identity matrix if it has not been set yet.

virtual const char* Enlighten::IPrecompInputCubeMap::GetName

public: const char * GetName() const

Get the full name.

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.

virtual bool Enlighten::IPrecompInputCubeMap::SetFaceWidth

public: bool SetFaceWidth
(
Geo::s32 faceWidth
)

Set the width and length of face in the cube map.

Cube map faces are always square and their width must be a power of two. The minimum face width is 2. The maximum this function will allow is set to 4096, but in practice this size is impractical and is unlikely to successfully precompute. A maximum width of 256 is a more practical limit for the regular cube map solution due to the precompute time involved. The default is 16 - a 16x16x6 pixel map.

Returns

True, if the value was correctly set. False if faceWidth is not a valid face width.

virtual void Enlighten::IPrecompInputCubeMap::SetId

public: void SetId
(
Geo::GeoGuid id
)

Set the unique ID of this cube map.

virtual bool Enlighten::IPrecompInputCubeMap::SetLocation

public: bool SetLocation
(
const Geo::Matrix & location
)

Set the world space position and orientation of the cube map.

Parameters

[in]

location

The world space location as a matrix encoding rotation and position only. Scale/skew is not supported.

Returns

True if operation succeeded, false if the value cannot be used (e.g. infs, nans, non-orthogonal, scaled)

virtual void Enlighten::IPrecompInputCubeMap::SetName

public: void SetName
(
const char * name
)

Set a globally unique name.