AnalogNode

class AnalogNode

Bases: DataNode

This is the primary interface to analog controls like sliders and joysticks associated with a ClientBase. This creates a node that connects to the named analog device, if it exists, and provides hooks to the user to read the state of any of the sequentially numbered controls associated with that device.

Each control can return a value ranging from -1 to 1, reflecting the current position of the control within its total range of motion.

The user may choose up to two analog controls to place on the data graph as the two channels of an xy datagram, similarly to the way a mouse places its position data. In this way, an AnalogNode may be used in place of a mouse.

Inheritance diagram

explicit AnalogNode(ClientBase *client, std::string const &device_name)

explicit AnalogNode(InputDevice *device)

AnalogNode(AnalogNode const&) = default

void clear_output(int channel)

Removes the output to the data graph associated with the indicated channel. See set_output().

static TypeHandle get_class_type(void)

double get_control_state(int index) const

Returns the current position of indicated analog control identified by its index number, or 0.0 if the control is unknown. The normal range of a single control is -1.0 to 1.0.

int get_num_controls(void) const

Returns the number of analog controls known to the AnalogNode. This number may change as more controls are discovered.

int get_output(int channel) const

Returns the analog control index that is output to the data graph on the indicated channel, or -1 if no control is output on that channel. See set_output().

bool is_control_known(int index) const

Returns true if the state of the indicated analog control is known, or false if we have never heard anything about this particular control.

bool is_output_flipped(int channel) const

Returns true if the analog control index that is output to the data graph on the indicated channel is flipped. See set_output().

bool is_valid(void) const

Returns true if the AnalogNode is valid and connected to a server, false otherwise.

void set_output(int channel, int index, bool flip)

Causes a particular analog control to be placed in the data graph for the indicated channel. Normally, a mouse uses channels 0 and 1 for the X and Y information, respectively; channels 0, 1, and 2 are available. If flip is true, the analog control value will be reversed before outputting it.