VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCursor2D Class Reference

generate a 2D cursor representation More...

#include <vtkCursor2D.h>

Inheritance diagram for vtkCursor2D:
[legend]
Collaboration diagram for vtkCursor2D:
[legend]

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkCursor2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetModelBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
 
void SetModelBounds (double bounds[6])
 
virtual double * GetModelBounds ()
 
virtual void GetModelBounds (double data[6])
 
void SetFocalPoint (double x[3])
 
void SetFocalPoint (double x, double y, double z)
 
virtual double * GetFocalPoint ()
 
virtual void GetFocalPoint (double data[3])
 
virtual void SetOutline (int)
 
virtual int GetOutline ()
 
virtual void OutlineOn ()
 
virtual void OutlineOff ()
 
virtual void SetAxes (int)
 
virtual int GetAxes ()
 
virtual void AxesOn ()
 
virtual void AxesOff ()
 
virtual void SetRadius (double)
 
virtual double GetRadius ()
 
virtual void SetPoint (int)
 
virtual int GetPoint ()
 
virtual void PointOn ()
 
virtual void PointOff ()
 
virtual void SetTranslationMode (int)
 
virtual int GetTranslationMode ()
 
virtual void TranslationModeOn ()
 
virtual void TranslationModeOff ()
 
virtual void SetWrap (int)
 
virtual int GetWrap ()
 
virtual void WrapOn ()
 
virtual void WrapOff ()
 
void AllOn ()
 
void AllOff ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkCursor2DSafeDownCast (vtkObjectBase *o)
 
static vtkCursor2DNew ()
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkCursor2D ()
 
 ~vtkCursor2D ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

Protected Attributes

double ModelBounds [6]
 
double FocalPoint [3]
 
int Outline
 
int Axes
 
int Point
 
double Radius
 
int TranslationMode
 
int Wrap
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

generate a 2D cursor representation

vtkCursor2D is a class that generates a 2D cursor representation. The cursor consists of two intersection axes lines that meet at the cursor focus. Several optional features are available as well. An optional 2D bounding box may be enabled. An inner radius, centered at the focal point, can be set that erases the intersecting lines (e.g., it leaves a clear area under the focal point so you can see what you are selecting). And finally, an optional point can be enabled located at the focal point. All of these features can be turned on and off independently.

Tests:
vtkCursor2D (Tests)

Definition at line 39 of file vtkCursor2D.h.

Member Typedef Documentation

Definition at line 42 of file vtkCursor2D.h.

Constructor & Destructor Documentation

vtkCursor2D::vtkCursor2D ( )
protected
vtkCursor2D::~vtkCursor2D ( )
inlineprotected

Definition at line 129 of file vtkCursor2D.h.

Member Function Documentation

static int vtkCursor2D::IsTypeOf ( const char *  type)
static
virtual int vtkCursor2D::IsA ( const char *  type)
virtual

Reimplemented from vtkPolyDataAlgorithm.

static vtkCursor2D* vtkCursor2D::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkCursor2D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

vtkCursor2D* vtkCursor2D::NewInstance ( ) const
void vtkCursor2D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkCursor2D* vtkCursor2D::New ( )
static

Construct with model bounds = (-10,10,-10,10), focal point = (0,0), radius=2, all parts of cursor visible, and wrapping off.

void vtkCursor2D::SetModelBounds ( double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
)

Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie.

void vtkCursor2D::SetModelBounds ( double  bounds[6])

Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie.

virtual double* vtkCursor2D::GetModelBounds ( )
virtual

Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie.

virtual void vtkCursor2D::GetModelBounds ( double  data[6])
virtual

Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie.

void vtkCursor2D::SetFocalPoint ( double  x[3])

Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.) Note that the method takes a 3D point but ignores the z-coordinate value.

void vtkCursor2D::SetFocalPoint ( double  x,
double  y,
double  z 
)
inline

Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.) Note that the method takes a 3D point but ignores the z-coordinate value.

Definition at line 66 of file vtkCursor2D.h.

virtual double* vtkCursor2D::GetFocalPoint ( )
virtual

Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.) Note that the method takes a 3D point but ignores the z-coordinate value.

virtual void vtkCursor2D::GetFocalPoint ( double  data[3])
virtual

Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.) Note that the method takes a 3D point but ignores the z-coordinate value.

virtual void vtkCursor2D::SetOutline ( int  )
virtual

Turn on/off the wireframe bounding box.

virtual int vtkCursor2D::GetOutline ( )
virtual

Turn on/off the wireframe bounding box.

virtual void vtkCursor2D::OutlineOn ( )
virtual

Turn on/off the wireframe bounding box.

virtual void vtkCursor2D::OutlineOff ( )
virtual

Turn on/off the wireframe bounding box.

virtual void vtkCursor2D::SetAxes ( int  )
virtual

Turn on/off the wireframe axes.

virtual int vtkCursor2D::GetAxes ( )
virtual

Turn on/off the wireframe axes.

virtual void vtkCursor2D::AxesOn ( )
virtual

Turn on/off the wireframe axes.

virtual void vtkCursor2D::AxesOff ( )
virtual

Turn on/off the wireframe axes.

virtual void vtkCursor2D::SetRadius ( double  )
virtual

Specify a radius for a circle. This erases the cursor lines around the focal point.

virtual double vtkCursor2D::GetRadius ( )
virtual

Specify a radius for a circle. This erases the cursor lines around the focal point.

virtual void vtkCursor2D::SetPoint ( int  )
virtual

Turn on/off the point located at the cursor focus.

virtual int vtkCursor2D::GetPoint ( )
virtual

Turn on/off the point located at the cursor focus.

virtual void vtkCursor2D::PointOn ( )
virtual

Turn on/off the point located at the cursor focus.

virtual void vtkCursor2D::PointOff ( )
virtual

Turn on/off the point located at the cursor focus.

virtual void vtkCursor2D::SetTranslationMode ( int  )
virtual

Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off.

virtual int vtkCursor2D::GetTranslationMode ( )
virtual

Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off.

virtual void vtkCursor2D::TranslationModeOn ( )
virtual

Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off.

virtual void vtkCursor2D::TranslationModeOff ( )
virtual

Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off.

virtual void vtkCursor2D::SetWrap ( int  )
virtual

Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).

virtual int vtkCursor2D::GetWrap ( )
virtual

Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).

virtual void vtkCursor2D::WrapOn ( )
virtual

Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).

virtual void vtkCursor2D::WrapOff ( )
virtual

Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).

void vtkCursor2D::AllOn ( )

Turn every part of the cursor on or off.

void vtkCursor2D::AllOff ( )

Turn every part of the cursor on or off.

int vtkCursor2D::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

double vtkCursor2D::ModelBounds[6]
protected

Definition at line 133 of file vtkCursor2D.h.

double vtkCursor2D::FocalPoint[3]
protected

Definition at line 134 of file vtkCursor2D.h.

int vtkCursor2D::Outline
protected

Definition at line 135 of file vtkCursor2D.h.

int vtkCursor2D::Axes
protected

Definition at line 136 of file vtkCursor2D.h.

int vtkCursor2D::Point
protected

Definition at line 137 of file vtkCursor2D.h.

double vtkCursor2D::Radius
protected

Definition at line 138 of file vtkCursor2D.h.

int vtkCursor2D::TranslationMode
protected

Definition at line 139 of file vtkCursor2D.h.

int vtkCursor2D::Wrap
protected

Definition at line 140 of file vtkCursor2D.h.


The documentation for this class was generated from the following file: