vtkPVAxesWidget Class Reference

A widget to manipulate vtkPVAxesWidget. More...

#include <vtkPVAxesWidget.h>

Inheritance diagram for vtkPVAxesWidget:

Collaboration diagram for vtkPVAxesWidget:

Public Types
typedef vtkInteractorObserver	Superclass
Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetInteractor (vtkRenderWindowInteractor *iren) override
	Overridden to add interaction observers. More...
virtual vtkRenderer *	GetRenderer ()
	Get the renderer. More...
void	SetEnabled (int) override
	Overridden to update this->Enabled and hide outline when disabled. More...
void	SetAxesActor (vtkPVAxesActor *actor)
	Set/get the axes actor to be displayed in this 3D widget. More...
virtual vtkPVAxesActor *	GetAxesActor ()
	Set/get the axes actor to be displayed in this 3D widget. More...
void	SetParentRenderer (vtkRenderer *ren)
	Set the renderer this 3D widget will be contained in. More...
vtkRenderer *	GetParentRenderer ()
	Set the renderer this 3D widget will be contained in. More...
void	SetVisibility (bool val)
	Get/Set the visibility. More...
bool	GetVisibility ()
	Get/Set the visibility. More...
void	SetOutlineColor (double r, double g, double b)
	Set/get the color of the outline of this widget. More...
double *	GetOutlineColor ()
	Set/get the color of the outline of this widget. More...
void	SetAxisLabelColor (double r, double g, double b)
	Set/get the color of the axis labels of this widget. More...
double *	GetAxisLabelColor ()
	Set/get the color of the axis labels of this widget. More...
void	SetViewport (double minX, double minY, double maxX, double maxY)
	Set/get the viewport to position/size this 3D widget. More...
double *	GetViewport ()
	Set/get the viewport to position/size this 3D widget. More...
void	SetXAxisColor (double r, double g, double b)
	Set the color and visibility of each individual axis. More...
void	SetYAxisColor (double r, double g, double b)
	Set the color and visibility of each individual axis. More...
void	SetZAxisColor (double r, double g, double b)
	Set the color and visibility of each individual axis. More...
void	SetXAxisVisibility (bool vis)
	Set the color and visibility of each individual axis. More...
void	SetYAxisVisibility (bool vis)
	Set the color and visibility of each individual axis. More...
void	SetZAxisVisibility (bool vis)
	Set the color and visibility of each individual axis. More...
void	SetXAxisLabelText (const char *text)
	Set the color and visibility of each individual axis. More...
void	SetYAxisLabelText (const char *text)
	Set the color and visibility of each individual axis. More...
void	SetZAxisLabelText (const char *text)
	Set the color and visibility of each individual axis. More...
Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const
virtual void	OnChar ()
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual vtkRenderWindowInteractor *	GetInteractor ()
virtual void	SetPriority (float)
virtual float	GetPriority ()
virtual void	PickingManagedOn ()
virtual void	PickingManagedOff ()
virtual void	SetPickingManaged (bool)
virtual bool	GetPickingManaged ()
virtual void	SetKeyPressActivation (int)
virtual int	GetKeyPressActivation ()
virtual void	KeyPressActivationOn ()
virtual void	KeyPressActivationOff ()
virtual void	SetKeyPressActivationValue (char)
virtual char	GetKeyPressActivationValue ()
virtual vtkRenderer *	GetDefaultRenderer ()
virtual void	SetDefaultRenderer (vtkRenderer *)
virtual vtkRenderer *	GetCurrentRenderer ()
virtual void	SetCurrentRenderer (vtkRenderer *)
void	GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	ReleaseFocus ()
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual vtkRenderWindowInteractor *	GetInteractor ()
virtual void	SetPriority (float)
virtual float	GetPriority ()
virtual void	PickingManagedOn ()
virtual void	PickingManagedOff ()
virtual void	SetPickingManaged (bool)
virtual bool	GetPickingManaged ()
virtual void	SetKeyPressActivation (int)
virtual int	GetKeyPressActivation ()
virtual void	KeyPressActivationOn ()
virtual void	KeyPressActivationOff ()
virtual void	SetKeyPressActivationValue (char)
virtual char	GetKeyPressActivationValue ()
virtual vtkRenderer *	GetDefaultRenderer ()
virtual void	SetDefaultRenderer (vtkRenderer *)
virtual vtkRenderer *	GetCurrentRenderer ()
virtual void	SetCurrentRenderer (vtkRenderer *)
void	GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	ReleaseFocus ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPVAxesWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkPVAxesWidget *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)
static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)
static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Static Public Attributes
static const int	RendererLayer = 1
	Layer number to use for the internal renderer created by vtkPVAxesWidget. More...

Protected Types
enum	AxesWidgetState {   Outside = 0, Inside, TopLeft, TopRight,   BottomLeft, BottomRight }

Protected Member Functions
	vtkPVAxesWidget ()
	~vtkPVAxesWidget () override
void	UpdateCameraFromParentRenderer ()
	Callback to keep the camera for the axes actor up to date with the camera in the parent renderer. More...
void	UpdateCursorIcon ()
void	SetMouseCursor (int cursorState)
void	OnButtonPress ()
void	OnMouseMove ()
void	OnButtonRelease ()
void	MoveWidget ()
void	ResizeTopLeft ()
void	ResizeTopRight ()
void	ResizeBottomLeft ()
void	ResizeBottomRight ()
void	SquareRenderer ()
Protected Member Functions inherited from vtkInteractorObserver
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInteractorObserver ()
	~vtkInteractorObserver ()
virtual void	RegisterPickers ()
void	UnRegisterPickers ()
virtual void	PickersModified ()
vtkPickingManager *	GetPickingManager ()
int	RequestCursorShape (int requestedShape)
virtual void	StartInteraction ()
virtual void	EndInteraction ()
void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
virtual void	StartInteraction ()
virtual void	EndInteraction ()
void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
static void	ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)

Protected Attributes
vtkRenderer *	Renderer
vtkRenderer *	ParentRenderer
vtkPVAxesActor *	AxesActor
vtkPolyData *	Outline
vtkActor2D *	OutlineActor
int	MouseCursorState
int	Moving
int	StartPosition [2]
unsigned long	StartEventObserverId
Protected Attributes inherited from vtkInteractorObserver
int	Enabled
vtkCallbackCommand *	EventCallbackCommand
vtkCallbackCommand *	KeyPressCallbackCommand
float	Priority
bool	PickingManaged
int	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

A widget to manipulate vtkPVAxesWidget.

This widget creates and manages its own vtkPVAxesActor. To use this widget, make sure you call SetParentRenderer and SetInteractor (if interactivity is needed). Use SetEnabled to enable/disable interactivity and SetVisibility to show/hide the axes.

Note

This is an old class that uses old style for create widgets. Please don't use it as a reference for creating similar elements.

Definition at line 29 of file vtkPVAxesWidget.h.

Member Typedef Documentation

Superclass

typedef vtkInteractorObserver vtkPVAxesWidget::Superclass

Definition at line 33 of file vtkPVAxesWidget.h.

Member Enumeration Documentation

AxesWidgetState

enum vtkPVAxesWidget::AxesWidgetState

protected

Enumerator
Outside
Inside
TopLeft
TopRight
BottomLeft
BottomRight

Definition at line 151 of file vtkPVAxesWidget.h.

Constructor & Destructor Documentation

vtkPVAxesWidget()

vtkPVAxesWidget::vtkPVAxesWidget ( )

protected

~vtkPVAxesWidget()

vtkPVAxesWidget::~vtkPVAxesWidget ( )

overrideprotected

Member Function Documentation

New()

static vtkPVAxesWidget* vtkPVAxesWidget::New ( )

static

GetClassName()

virtual const char* vtkPVAxesWidget::GetClassName ( )

virtual

IsTypeOf()

static int vtkPVAxesWidget::IsTypeOf ( const char *  type )

static

IsA()

virtual int vtkPVAxesWidget::IsA ( const char *  type )

virtual

Reimplemented from vtkInteractorObserver.

SafeDownCast()

static vtkPVAxesWidget* vtkPVAxesWidget::SafeDownCast ( vtkObject *  o )

static

PrintSelf()

void vtkPVAxesWidget::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Reimplemented from vtkInteractorObserver.

SetAxesActor()

void vtkPVAxesWidget::SetAxesActor

(

vtkPVAxesActor *

actor

)

Set/get the axes actor to be displayed in this 3D widget.

GetAxesActor()

virtual vtkPVAxesActor* vtkPVAxesWidget::GetAxesActor ( )

virtual

Set/get the axes actor to be displayed in this 3D widget.

SetParentRenderer()

void vtkPVAxesWidget::SetParentRenderer

(

vtkRenderer *

ren

)

Set the renderer this 3D widget will be contained in.

GetParentRenderer()

vtkRenderer* vtkPVAxesWidget::GetParentRenderer

(

)

Set the renderer this 3D widget will be contained in.

SetInteractor()

void vtkPVAxesWidget::SetInteractor ( vtkRenderWindowInteractor *  iren )

overridevirtual

Overridden to add interaction observers.

Reimplemented from vtkInteractorObserver.

GetRenderer()

virtual vtkRenderer* vtkPVAxesWidget::GetRenderer ( )

virtual

Get the renderer.

SetEnabled()

void vtkPVAxesWidget::SetEnabled ( int  )

overridevirtual

Overridden to update this->Enabled and hide outline when disabled.

Use this method to enable/disable interactivity.

Reimplemented from vtkInteractorObserver.

SetVisibility()

void vtkPVAxesWidget::SetVisibility

(

bool

val

)

Get/Set the visibility.

Note if visibility is off, Enabled state is ignored and assumed off.

GetVisibility()

bool vtkPVAxesWidget::GetVisibility

(

)

Get/Set the visibility.

Note if visibility is off, Enabled state is ignored and assumed off.

SetOutlineColor()

void vtkPVAxesWidget::SetOutlineColor	(	double	r,
		double	g,
		double	b
	)

Set/get the color of the outline of this widget.

The outline is visible when (in interactive mode) the cursor is over this 3D widget.

GetOutlineColor()

double* vtkPVAxesWidget::GetOutlineColor

(

)

Set/get the color of the outline of this widget.

The outline is visible when (in interactive mode) the cursor is over this 3D widget.

SetAxisLabelColor()

void vtkPVAxesWidget::SetAxisLabelColor	(	double	r,
		double	g,
		double	b
	)

Set/get the color of the axis labels of this widget.

GetAxisLabelColor()

double* vtkPVAxesWidget::GetAxisLabelColor

(

)

Set/get the color of the axis labels of this widget.

SetViewport()

void vtkPVAxesWidget::SetViewport	(	double	minX,
		double	minY,
		double	maxX,
		double	maxY
	)

Set/get the viewport to position/size this 3D widget.

GetViewport()

double* vtkPVAxesWidget::GetViewport

(

)

Set/get the viewport to position/size this 3D widget.

SetXAxisColor()

void vtkPVAxesWidget::SetXAxisColor	(	double	r,
		double	g,
		double	b
	)

Set the color and visibility of each individual axis.

SetYAxisColor()

void vtkPVAxesWidget::SetYAxisColor	(	double	r,
		double	g,
		double	b
	)

Set the color and visibility of each individual axis.

SetZAxisColor()

void vtkPVAxesWidget::SetZAxisColor	(	double	r,
		double	g,
		double	b
	)

Set the color and visibility of each individual axis.

SetXAxisVisibility()

void vtkPVAxesWidget::SetXAxisVisibility

(

bool

vis

)

Set the color and visibility of each individual axis.

SetYAxisVisibility()

void vtkPVAxesWidget::SetYAxisVisibility

(

bool

vis

)

Set the color and visibility of each individual axis.

SetZAxisVisibility()

void vtkPVAxesWidget::SetZAxisVisibility

(

bool

vis

)

Set the color and visibility of each individual axis.

SetXAxisLabelText()

void vtkPVAxesWidget::SetXAxisLabelText

(

const char *

text

)

Set the color and visibility of each individual axis.

SetYAxisLabelText()

void vtkPVAxesWidget::SetYAxisLabelText

(

const char *

text

)

Set the color and visibility of each individual axis.

SetZAxisLabelText()

void vtkPVAxesWidget::SetZAxisLabelText

(

const char *

text

)

Set the color and visibility of each individual axis.

ProcessEvents()

static void vtkPVAxesWidget::ProcessEvents ( vtkObject *  object, unsigned long  event, void *  clientdata, void *  calldata  )

staticprotected

UpdateCameraFromParentRenderer()

void vtkPVAxesWidget::UpdateCameraFromParentRenderer ( )

protected

Callback to keep the camera for the axes actor up to date with the camera in the parent renderer.

UpdateCursorIcon()

void vtkPVAxesWidget::UpdateCursorIcon ( )

protected

SetMouseCursor()

void vtkPVAxesWidget::SetMouseCursor ( int  cursorState )

protected

OnButtonPress()

void vtkPVAxesWidget::OnButtonPress ( )

protected

OnMouseMove()

void vtkPVAxesWidget::OnMouseMove ( )

protected

OnButtonRelease()

void vtkPVAxesWidget::OnButtonRelease ( )

protected

MoveWidget()

void vtkPVAxesWidget::MoveWidget ( )

protected

ResizeTopLeft()

void vtkPVAxesWidget::ResizeTopLeft ( )

protected

ResizeTopRight()

void vtkPVAxesWidget::ResizeTopRight ( )

protected

ResizeBottomLeft()

void vtkPVAxesWidget::ResizeBottomLeft ( )

protected

ResizeBottomRight()

void vtkPVAxesWidget::ResizeBottomRight ( )

protected

SquareRenderer()

void vtkPVAxesWidget::SquareRenderer ( )

protected

Member Data Documentation

RendererLayer

const int vtkPVAxesWidget::RendererLayer = 1

static

Layer number to use for the internal renderer created by vtkPVAxesWidget.

Definition at line 39 of file vtkPVAxesWidget.h.

Renderer

vtkRenderer* vtkPVAxesWidget::Renderer

protected

Definition at line 128 of file vtkPVAxesWidget.h.

ParentRenderer

vtkRenderer* vtkPVAxesWidget::ParentRenderer

protected

Definition at line 129 of file vtkPVAxesWidget.h.

AxesActor

vtkPVAxesActor* vtkPVAxesWidget::AxesActor

protected

Definition at line 131 of file vtkPVAxesWidget.h.

Outline

vtkPolyData* vtkPVAxesWidget::Outline

protected

Definition at line 132 of file vtkPVAxesWidget.h.

OutlineActor

vtkActor2D* vtkPVAxesWidget::OutlineActor

protected

Definition at line 133 of file vtkPVAxesWidget.h.

MouseCursorState

int vtkPVAxesWidget::MouseCursorState

protected

Definition at line 144 of file vtkPVAxesWidget.h.

Moving

int vtkPVAxesWidget::Moving

protected

Definition at line 145 of file vtkPVAxesWidget.h.

StartPosition

int vtkPVAxesWidget::StartPosition[2]

protected

Definition at line 146 of file vtkPVAxesWidget.h.

StartEventObserverId

unsigned long vtkPVAxesWidget::StartEventObserverId

protected

Definition at line 171 of file vtkPVAxesWidget.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkPVAxesWidget.h