Class EventInput

Defined in File WMX3Api.h

Inheritance Relationships

Derived Types

public CoreMotionEventInput (Class CoreMotionEventInput)
public EventApiEventInput (Class EventApiEventInput)
public IoEventInput (Class IoEventInput)
public UserMemoryEventInput (Class UserMemoryEventInput)

Class Documentation

class EventInput

This virtual class defines the interface to specify event inputs (conditions to trigger the event). Each module that defines event inputs defines a class that inherits this class.

Subclassed by CoreMotionEventInput, EventApiEventInput, IoEventInput, UserMemoryEventInput

Public Functions

virtual int GetInputModuleId() = 0

Return the ID of the module that defines the event input.

virtual WMX3APIFUNC GetInputData(unsigned char *buff, int buffSize, int *dataSize, char *initialState) = 0

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 int that will contain the size of the binary representation of the member variables, in bytes. This size of the buffer will be occupied.
initialState – [out] A pointer to a char that will contain the initialState (triggered or untriggered) of the input function. This determines whether the event can trigger when the event is enabled.

virtual WMX3APIFUNC SetInputData(int moduleId, unsigned char *data, int dataSize) = 0

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.