class Enlighten IPrecompInputSystem

This is the documentation for Enlighten.

class Enlighten IPrecompInputSystem

class Enlighten::IPrecompInputSystem

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

Handle to the InputSystem.

Functions

Name

Description

Name

Description

AddInstances(const PrecompInputInstance *, const PrecompInputInstance *)

Copy instances between [begin, end) into this object.

ClearAllMaterialInfo()

Clears all existing material properties for this system.

Create()

Create a new IPrecompInputSystem.

GetBuildParameters()

Get the build parameters for this system.

GetBuildParameters()

Get the build parameters for this system.

GetId()

Returns the globally unique ID of this system.

GetInstanceArray()

Access to the array of input instances.

GetInstanceCount()

Retrieves the number of object instances in the system.

GetMaterialInfo(Geo::GeoGuid, Geo::GeoGuid, Geo::GeoGuid, PrecompMaterialInfo &)

Retrieves the material properties that will be used for the given combination of instance, mesh and material GUID.

GetName()

Returns the globally unique name of this system.

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.

SetId(Geo::GeoGuid)

Sets the globally unique ID of this system.

SetMaterialInfo(Geo::GeoGuid, Geo::GeoGuid, Geo::GeoGuid, const PrecompMaterialInfo &)

Sets material properties for the given combination of instance, mesh and material GUIDs.

SetName(const char *)

Sets the globally unique name of this system.



virtual bool Enlighten::IPrecompInputSystem::AddInstances


public: bool AddInstances
(
    const PrecompInputInstance * begin,
    const PrecompInputInstance * end
)


Copy instances between [begin, end) into this object.

 

Parameters

[in]

begin

A pointer to the first element to be added

[in]

end

A pointer to an element one past the last entity (as standard STL syntax)

Returns

True if operation succeeded, false if there was not enough memory to satisfy request

 



virtual void Enlighten::IPrecompInputSystem::ClearAllMaterialInfo


public: void ClearAllMaterialInfo()


Clears all existing material properties for this system.