Class ApiBufferEventOutput

Defined in File ApiBufferApi.h

Nested Relationships

Nested Types

Union ApiBufferEventOutput::OutputFunctionArguments

Inheritance Relationships

Base Type

public EventOutput (Class EventOutput)

Class Documentation

class ApiBufferEventOutput : public EventOutput 

This class defines event output functions that can be processed by the ApiBuffer module. Also see API Buffer Outputs.

Public Types

enum ApiBufferEventOutputType

This enumerator class enumerates the types of event output functions that can be processed by this module.

Values:

enumerator StartAPIBuffer

This output function starts the execution of an API buffer.

The parameters for this output function are specified in the StartAPIBuffer structure of output.

enumerator HaltApiBuffer

This output function stops the execution of an API buffer.

The parameters for this output function are specified in the HaltAPIBuffer structure of output.

Public Functions

ApiBufferEventOutput()

virtual int GetOutputModuleId(): Return the ModuleId of the CoreMotion module.

virtual WMX3APIFUNC GetOutputData(unsigned char *buff, int buffSize, int *dataSize)

Convert the values specified in other member variables of the class inheriting this class to a binary representation that can be sent to the engine.

Parameters:

buff – [out] A pointer to a buffer that will contain the binary representation of the member variables.
buffSize – [in] The size of the buffer in bytes.
dataSize – [out] A pointer to an unsigned int that will contain the size of the binary representation of the member variables, in bytes. This size of the buffer will be occupied.

virtual WMX3APIFUNC SetOutputData(int moduleId, unsigned char *data, int dataSize)

Convert the binary representation of the values specified in other members of the class inheriting this class and copies them back to the other members.

Parameters:

moduleId – [in] The ID of the module that defines the binary representation of the member variables.
data – [in] A pointer to a buffer that contains the binary representation of the member variables.
dataSize – [in] The size of the buffer in bytes.

Public Members

ApiBufferEventOutputType outputFunction: Specifies the event output function.

union wmx3Api::ApiBufferEventOutput::OutputFunctionArguments output: Specifies the arguments for the event output function.

union OutputFunctionArguments

This union defines the structs containing arguments for each output function.

Public Functions

OutputFunctionArguments()

Public Members

struct wmx3Api::ApiBufferEventOutput::OutputFunctionArguments::StartAPIBuffer startAPIBuffer

struct wmx3Api::ApiBufferEventOutput::OutputFunctionArguments::HaltAPIBuffer haltAPIBuffer

struct HaltAPIBuffer

This structure contains arguments for the HaltAPIBuffer output function.

Public Members

unsigned int channel: API o b t @ ̃` l B.

struct StartAPIBuffer

This structure contains arguments for the StartAPIBuffer output function.

Public Members

unsigned int channel: The channel of the API buffer.