vtk
Class vtkInteractorObserver

java.lang.Object
  extended byvtk.vtkObjectBase
      extended byvtk.vtkObject
          extended byvtk.vtkInteractorObserver
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
vtk3DWidget, vtkInteractorEventRecorder, vtkInteractorStyle, vtkScalarBarWidget, vtkXYPlotWidget

public class vtkInteractorObserver
extends vtkObject
implements java.io.Serializable

vtkInteractorObserver - an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor. vtkInteractorObserver is an abstract superclass for subclasses that observe events invoked by vtkRenderWindowInteractor. These subclasses are typically things like 3D widgets; objects that interact with actors in the scene, or interactively probe the scene for information. vtkInteractorObserver defines the method SetInteractor() and enables and disables the processing of events by the vtkInteractorObserver. Use the methods EnabledOn() or SetEnabled(1) to turn on the interactor observer, and the methods EnabledOff() or SetEnabled(0) to turn off the interactor. To support interactive manipulation of objects, this class (and subclasses) invoke the events StartInteractionEvent, InteractionEvent, and EndInteractionEvent. These events are invoked when the vtkInteractorObserver enters a state where rapid response is desired: mouse motion, etc. The events can be used, for example, to set the desired update frame rate (StartInteractionEvent), operate on data or update a pipeline (InteractionEvent), and set the desired frame rate back to normal values (EndInteractionEvent). Two other events, EnableEvent and DisableEvent, are invoked when the interactor observer is enabled or disabled. JavaBean wrapper for vtkInteractorObserver object.

Author:
vtk2jbean Automatic JavaBean wrapper for VTK.
See Also:
vtk3DWidget, vtkBoxWidget, Serialized Form

Field Summary
protected  java.beans.PropertyChangeSupport changes
           
 
Fields inherited from class vtk.vtkObjectBase
vtkId
 
Constructor Summary
  vtkInteractorObserver()
           
protected vtkInteractorObserver(int dmy)
           
 
Method Summary
 void enabledOff()
          Methods for turning the interactor observer on and off, and determining its state.
 void enabledOn()
          Methods for turning the interactor observer on and off, and determining its state.
 java.lang.String getClassName()
          Return the class name as a string.
 vtkRenderer getCurrentRenderer()
          Set/Get the current renderer.
 vtkRenderer getDefaultRenderer()
          Set/Get the default renderer to use when activating the interactor observer.
 int getEnabled()
          Methods for turning the interactor observer on and off, and determining its state.
 vtkRenderWindowInteractor getInteractor()
          This method is used to associate the widget with the render window interactor.
 int getKeyPressActivation()
          Enable/Disable of the use of a keypress to turn on and off the interactor observer.
 char getKeyPressActivationValue()
          Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
 double getPriority()
          Set/Get the priority at which events are processed.
 double getPriorityMaxValue()
          Set/Get the priority at which events are processed.
 double getPriorityMinValue()
          Set/Get the priority at which events are processed.
 vtkInteractorObserver getThisInteractorObserver()
           
 int isA(java.lang.String id0)
          Return 1 if this class is the same type of (or a subclass of) the named class.
 void keyPressActivationOff()
          Enable/Disable of the use of a keypress to turn on and off the interactor observer.
 void keyPressActivationOn()
          Enable/Disable of the use of a keypress to turn on and off the interactor observer.
 void off()
          This method is used to associate the widget with the render window interactor.
 void on()
          Methods for turning the interactor observer on and off, and determining its state.
 void onChar()
           
 void setCurrentRenderer(vtkRenderer id0)
          Set/Get the current renderer.
 void setDefaultRenderer(vtkRenderer id0)
          Set/Get the default renderer to use when activating the interactor observer.
 void setEnabled(int id0)
          Methods for turning the interactor observer on and off, and determining its state.
 void setInteractor(vtkRenderWindowInteractor id0)
          This method is used to associate the widget with the render window interactor.
 void setKeyPressActivation(int id0)
          Enable/Disable of the use of a keypress to turn on and off the interactor observer.
 void setKeyPressActivationValue(char id0)
          Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
 void setPriority(double id0)
          Set/Get the priority at which events are processed.
protected  void VTKCastInit()
           
 
Methods inherited from class vtk.vtkObject
AddObserver, breakOnError, debugOff, debugOn, getDebug, getGlobalWarningDisplay, getMTime, getThisObject, globalWarningDisplayOff, globalWarningDisplayOn, hasObserver, hasObserver, invokeEvent, invokeEvent, modified, Print, PrintRevisions, register, removeObserver, removeObservers, removeObservers, setDebug, setGlobalWarningDisplay, unRegister, VTKInit
 
Methods inherited from class vtk.vtkObjectBase
addPropertyChangeListener, finalize, getReferenceCount, getThisObjectBase, isTypeOf, removePropertyChangeListener, setReferenceCount, VTKDelete
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

changes

protected java.beans.PropertyChangeSupport changes
Constructor Detail

vtkInteractorObserver

public vtkInteractorObserver()

vtkInteractorObserver

protected vtkInteractorObserver(int dmy)
Method Detail

getThisInteractorObserver

public vtkInteractorObserver getThisInteractorObserver()

getClassName

public java.lang.String getClassName()
Description copied from class: vtkObjectBase
Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:
getClassName in class vtkObject

isA

public int isA(java.lang.String id0)
Description copied from class: vtkObjectBase
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:
isA in class vtkObject

setEnabled

public void setEnabled(int id0)
Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()).


getEnabled

public int getEnabled()
Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()).


enabledOn

public void enabledOn()
Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()).


enabledOff

public void enabledOff()
Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()).


on

public void on()
Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()).


off

public void off()
This method is used to associate the widget with the render window interactor. Observers of the appropriate events invoked in the render window interactor are set up as a result of this method invocation. The SetInteractor() method must be invoked prior to enabling the vtkInteractorObserver.


setInteractor

public void setInteractor(vtkRenderWindowInteractor id0)
This method is used to associate the widget with the render window interactor. Observers of the appropriate events invoked in the render window interactor are set up as a result of this method invocation. The SetInteractor() method must be invoked prior to enabling the vtkInteractorObserver.


getInteractor

public vtkRenderWindowInteractor getInteractor()
This method is used to associate the widget with the render window interactor. Observers of the appropriate events invoked in the render window interactor are set up as a result of this method invocation. The SetInteractor() method must be invoked prior to enabling the vtkInteractorObserver.


setPriority

public void setPriority(double id0)
Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)


getPriorityMinValue

public double getPriorityMinValue()
Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)


getPriorityMaxValue

public double getPriorityMaxValue()
Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)


getPriority

public double getPriority()
Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)


setKeyPressActivation

public void setKeyPressActivation(int id0)
Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)


getKeyPressActivation

public int getKeyPressActivation()
Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)


keyPressActivationOn

public void keyPressActivationOn()
Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)


keyPressActivationOff

public void keyPressActivationOff()
Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)


setKeyPressActivationValue

public void setKeyPressActivationValue(char id0)
Specify which key press value to use to activate the interactor observer (if key press activation is enabled). By default, the key press activation value is 'i'. Note: once the SetInteractor() method is invoked, changing the key press activation value will not affect the key press until SetInteractor(NULL)/SetInteractor(iren) is called.


getKeyPressActivationValue

public char getKeyPressActivationValue()
Specify which key press value to use to activate the interactor observer (if key press activation is enabled). By default, the key press activation value is 'i'. Note: once the SetInteractor() method is invoked, changing the key press activation value will not affect the key press until SetInteractor(NULL)/SetInteractor(iren) is called.


getDefaultRenderer

public vtkRenderer getDefaultRenderer()
Set/Get the default renderer to use when activating the interactor observer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used. Alternatively, you can specify the renderer to bind the interactor to when the interactor observer is activated.


setDefaultRenderer

public void setDefaultRenderer(vtkRenderer id0)
Set/Get the default renderer to use when activating the interactor observer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used. Alternatively, you can specify the renderer to bind the interactor to when the interactor observer is activated.


getCurrentRenderer

public vtkRenderer getCurrentRenderer()
Set/Get the current renderer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used and assigned to this Ivar. Alternatively, you might want to set the CurrentRenderer explicitly. WARNING: note that if the DefaultRenderer Ivar is set (see above), it will always override the parameter passed to SetCurrentRenderer, unless it is NULL. (i.e., SetCurrentRenderer(foo) = SetCurrentRenderer(DefaultRenderer).


setCurrentRenderer

public void setCurrentRenderer(vtkRenderer id0)
Set/Get the current renderer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used and assigned to this Ivar. Alternatively, you might want to set the CurrentRenderer explicitly. WARNING: note that if the DefaultRenderer Ivar is set (see above), it will always override the parameter passed to SetCurrentRenderer, unless it is NULL. (i.e., SetCurrentRenderer(foo) = SetCurrentRenderer(DefaultRenderer).


onChar

public void onChar()

VTKCastInit

protected void VTKCastInit()
Overrides:
VTKCastInit in class vtkObject


Copyright © 2004 Sydney ViSLAB. All Rights Reserved.