Models

Model

class LuxFlux.fluxEngineNET.Model : IDisposable

fluxEngine Model

Public Functions

GroupInfo GroupInfo (int groupId)

Get the group information for a given group

Returns information about a group in a model. This consists of the name of the group as well as a color value as a 32bit integer. See the GroupInfo structure for further details.

The group id must be within 0 and one less than the number of groups in the model. For example, a model with 5 groups will have the ids 0, 1, 2, 3, and 4.

void Dispose ()

Dispose of this object

This will free all resources associated with this object. The object should not be used anymore after a call to this method.

Properties

int GroupCount { get; set; }

The number of groups in the model.

GroupInfo[] Groups { get; set; }

The information about all groups in a model

Public Static Functions

Model LoadFromMemory (Handle handle, byte[] data)

Load a model from memory

Param handle:

The fluxEngine handle. This is required as the loaded license determines whether specific features within a model are allowed

Param data:

The raw binary data of the model

Return:

The loaded model

Model LoadFromFile (Handle handle, string fileName)

Load a model from disk

Param handle:

The fluxEngine handle. This is required as the loaded license determines whether specific features within a model are allowed

Param fileName:

The name of the file to load

Return:

The loaded model

GroupInfo

class LuxFlux.fluxEngineNET.GroupInfo

Group information

This structure contains the information about a group that is stored within a given runtime model.

Public Members

string Name

The name of the group.

UInt32 Color

The color of the group

This is encoded in the format 0xffRRGGBB. To obtain the red, green and blue values of the color one may use the helper methods that are part of this structure.

Properties

byte ColorRedComponentValue { get; set; }

The red color component value

The red component value of the color of the group, in a range of 0 through 255.

byte ColorGreenComponentValue { get; set; }

The green color component value

The green component value of the color of the group, in a range of 0 through 255.

byte ColorBlueComponentValue { get; set; }

The blue color component value

The blue component value of the color of the group, in a range of 0 through 255.