Manipulator.Handle Class Reference


Detailed Description

A Handle defines a component of a manipulator.

It consists of:

  • nodes that define its geometry.
  • a start interaction callback, which is called when an interaction is started (typically when the handle is made active). The callback must take a handle and starting point for the interaction, as its arguments. A typical callback will change the appearance of the handle (or even the entire manipulator), and calculate any data that will be constant for the duration of the interaction.
  • an interaction callback, which is called to perform the manipulation designated to the handle (typically an operation performed on a given set of targets). The callback must take a handle, and the starting and ending points over which the interaction applies, as its arguments. A typical callback will perform the manipulation operation of the manipulator, with the handle providing the data.
  • an stop interaction callback, which is called when an interaction is stopped (typically when the handle is made inactive). The callback must take a handle as its argument. A typical callback will change the appearance of the handle (or even the entire manipulator), and discard any data that is no longer relevant.

#include <class_manipulator_1_1_handle.h>

Inheritance diagram for Manipulator.Handle:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ ()
  startInteraction ()
  Calls the start interaction callback with this handle and the given starting point as the arguments.
  interact ()
  Calls the interaction callback with this handle and the given starting and ending points as the arguments.
  stopInteraction ()
  Calls the stop interaction callback with this handle as the argument.
  containsNode ()
  Returns True if the given node is a part of this handle.
  getNodes ()
  Returns the nodes of this handle.
  isVisible ()
  Returns the last set visibility state of the handle.
  setVisible ()
  Sets the visibility of this handle.

Member Function Documentation

Manipulator.Handle.startInteraction ( )

Calls the start interaction callback with this handle and the given starting point as the arguments.

Manipulator.Handle.interact ( )

Calls the interaction callback with this handle and the given starting and ending points as the arguments.

Manipulator.Handle.stopInteraction ( )

Calls the stop interaction callback with this handle as the argument.

Manipulator.Handle.containsNode ( )

Returns True if the given node is a part of this handle.

Manipulator.Handle.getNodes ( )

Returns the nodes of this handle.

Manipulator.Handle.isVisible ( )

Returns the last set visibility state of the handle.

Manipulator.Handle.setVisible ( )

Sets the visibility of this handle.


Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle
Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle Manipulator.Handle