Class vtkMRMLLayerDMWidgetEventTranslationNode

• Defined in File vtkMRMLLayerDMWidgetEventTranslationNode.h

Nested Relationships

Nested Types

• Struct vtkMRMLLayerDMWidgetEventTranslationNode::EventKey

Inheritance Relationships

Base Type

• public vtkMRMLNode

Class Documentation

class vtkMRMLLayerDMWidgetEventTranslationNode : public vtkMRMLNode

Inheritance diagram for vtkMRMLLayerDMWidgetEventTranslationNode:

Collaboration diagram for vtkMRMLLayerDMWidgetEventTranslationNode:

MRML node responsible for storing widget event translation.

Provides utility static methods to access / register scene translation nodes for multi widget configuration scenarios.

Public Functions

vtkTypeMacro(vtkMRMLLayerDMWidgetEventTranslationNode, vtkMRMLNode)

vtkMRMLLayerDMWidgetEventTranslationNode(const vtkMRMLLayerDMWidgetEventTranslationNode&) = delete

void operator=(const vtkMRMLLayerDMWidgetEventTranslationNode&) = delete

void PrintSelf(ostream &os, vtkIndent indent) override

void Copy(vtkMRMLNode *node) override

void ReadXMLAttributes(const char **atts) override

void WriteXML(ostream &of, int indent) override

vtkMRMLNode *CreateNodeInstance() override

const char *GetNodeTagName() override

void SetTranslation(int widgetState, unsigned long interactionEvent, unsigned long widgetEvent, int modifier = vtkEvent::NoModifier)

Set translation for mouse click events.

void SetTranslationClickAndDrag(int widgetState, unsigned long interactionEvent, int widgetStateDragging, unsigned long widgetStartEvent, unsigned long widgetEndEvent, int modifiers = vtkEvent::NoModifier)

Set translation for mouse click and drag events.

void SetTranslationKeyboard(int widgetState, const std::string &keySym, unsigned long widgetEvent, int modifier = vtkEvent::NoModifier, int repeatCount = 1, unsigned long keyEvent = vtkCommand::KeyPressEvent)

Set translation for keystroke events.

int RemoveTranslationEvent(unsigned long widgetEvent)

Removes all translation events mapping to the given input event.

See also

BlockTranslationEvent

See also

Clear

Returns:

Number of erased translation events.

bool BlockTranslationEvent(unsigned long widgetEvent, bool isBlocked)

Block the widget event translation. Instead of returning this event, the

See also

Translate method will return vtkMRMLAbstractWidget::WidgetEventNone instead.

See also

BlockAllTranslationEvents

Returns:

previous block state for input event

bool BlockAllTranslationEvents(bool isBlocked)

Block all translation events.

See also

BlockTranslationEvent

Returns:

previous block state

unsigned long Translate(int widgetState, vtkMRMLInteractionEventData *eventData)

Get event from input event data and current widget state. If the event translation is blocked or specific widget event is blocked, returns vtkMRMLAbstractWidget::WidgetEventNone.

See also

BlockTranslationEvent

See also

BlockAllTranslationEvents

void Clear()

Clears all widget translations contained in the node.

int GetNumberOfTranslations() const

Returns:

the number of event translations currently mapped.

Public Static Functions

static vtkMRMLLayerDMWidgetEventTranslationNode *New()

static unsigned long GetEndInteractionEvent(unsigned long startInteractionEvent)

Returns the end interaction event value matching the input start interaction event. If no match is found, returns vtkMRMLAbstractWidget::WidgetEventNone value.

See also

SetEventTranslationClickAndDrag

static unsigned long GetClickEvent(unsigned long releaseEvent)

Returns the click event value matching the input release event. If no match is found, returns vtkMRMLAbstractWidget::WidgetEventNone value.

Protected Functions

vtkMRMLLayerDMWidgetEventTranslationNode() = default

~vtkMRMLLayerDMWidgetEventTranslationNode() override = default