vtkCamera3DRepresentation Class Reference

a class defining the representation for the vtkCamera3DWidget More...

#include <vtkCamera3DRepresentation.h>

Inheritance diagram for vtkCamera3DRepresentation:

Collaboration diagram for vtkCamera3DRepresentation:

Public Types
enum	{   Outside = 0 , Translating , TranslatingPosition , TranslatingNearTarget ,   TranslatingTarget , TranslatingUp , Scaling }
Public Types inherited from vtkWidgetRepresentation
enum	Axis {   NONE = -1 , XAxis = 0 , YAxis = 1 , ZAxis = 2 ,   Custom = 3 }
	Axis labels. More...
typedef vtkProp	Superclass
	Standard methods for instances of this class.
Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
void	SetInteractionState (int state)
	The interaction state may be set from a widget (e.g., vtkCamera3DWidget) or other object.
void	RegisterPickers () override
	Register internal Pickers in the Picking Manager.
void	GetActors (vtkPropCollection *) override
	These methods are necessary to make this representation behave as a vtkProp (i.e., support rendering).
void	PlaceWidget (double bounds[6]) override
	These are methods that satisfy vtkWidgetRepresentation's API.
void	BuildRepresentation () override
	These are methods that satisfy vtkWidgetRepresentation's API.
int	ComputeInteractionState (int X, int Y, int modify=0) override
	These are methods that satisfy vtkWidgetRepresentation's API.
void	StartWidgetInteraction (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation's API.
void	WidgetInteraction (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation's API.
double *	GetBounds () override
	These are methods that satisfy vtkWidgetRepresentation's API.
void	ReleaseGraphicsResources (vtkWindow *) override
	Methods supporting, and required by, the rendering process.
int	RenderOpaqueGeometry (vtkViewport *) override
	Methods supporting, and required by, the rendering process.
int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	Methods supporting, and required by, the rendering process.
vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Methods supporting, and required by, the rendering process.
virtual void	SetCamera (vtkCamera *camera)
	Set/Get the camera.
vtkCamera *	GetCamera ()
	Set/Get the camera.
virtual void	SetFrontHandleDistance (double)
	Set/Get the distance between camera position and the front handle.
virtual double	GetFrontHandleDistance ()
	Set/Get the distance between camera position and the front handle.
virtual void	SetUpHandleDistance (double)
	Set/Get the distance between camera position and the up handle.
virtual double	GetUpHandleDistance ()
	Set/Get the distance between camera position and the up handle.
void	SetTranslationAxisToXAxis ()
	Set/Get the constraint axis for translations.
void	SetTranslationAxisToYAxis ()
	Set/Get the constraint axis for translations.
void	SetTranslationAxisToZAxis ()
	Set/Get the constraint axis for translations.
void	SetTranslationAxisToNone ()
	Set/Get the constraint axis for translations.
virtual void	SetTranslationAxis (int)
	Set/Get the constraint axis for translations.
virtual int	GetTranslationAxis ()
	Set/Get the constraint axis for translations.
virtual void	SetTranslatingAll (bool)
	Set/Get whether to translate both position and target or not.
virtual bool	GetTranslatingAll ()
	Set/Get whether to translate both position and target or not.
virtual void	TranslatingAllOn ()
	Set/Get whether to translate both position and target or not.
virtual void	TranslatingAllOff ()
	Set/Get whether to translate both position and target or not.
void	SetFrustumVisibility (bool visible)
	Set/Get whether to show camera frustum.
virtual bool	GetFrustumVisibility ()
	Set/Get whether to show camera frustum.
virtual void	FrustumVisibilityOn ()
	Set/Get whether to show camera frustum.
virtual void	FrustumVisibilityOff ()
	Set/Get whether to show camera frustum.
void	SetSecondaryHandlesVisibility (bool visible)
	Set/Get whether to show secondary handles (spheres and lines).
virtual bool	GetSecondaryHandlesVisibility ()
	Set/Get whether to show secondary handles (spheres and lines).
virtual void	SecondaryHandlesVisibilityOn ()
	Set/Get whether to show secondary handles (spheres and lines).
virtual void	SecondaryHandlesVisibilityOff ()
	Set/Get whether to show secondary handles (spheres and lines).
Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PlaceWidget (double vtkNotUsed(bounds)[6])
	The following is a suggested API for widget representations.
virtual void	StartWidgetInteraction (double eventPos[2])
virtual void	WidgetInteraction (double newEventPos[2])
virtual void	EndWidgetInteraction (double newEventPos[2])
virtual int	ComputeInteractionState (int X, int Y, int modify=0)
virtual int	GetInteractionState ()
virtual void	Highlight (int vtkNotUsed(highlightOn))
double *	GetBounds () override
	Methods to make this class behave as a vtkProp.
void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkProp.
void	GetActors (vtkPropCollection *) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.
void	GetActors2D (vtkPropCollection *) override
void	GetVolumes (vtkPropCollection *) override
void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
int	RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override
int	RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override
int	RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override
int	RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override
vtkTypeBool	HasTranslucentPolygonalGeometry () override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.
virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.
virtual void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.
virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.
virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.
void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.
virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.
virtual void	SetRenderer (vtkRenderer *ren)
	Subclasses of vtkWidgetRepresentation must implement these methods.
virtual vtkRenderer *	GetRenderer ()
	Subclasses of vtkWidgetRepresentation must implement these methods.
virtual void	StartComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
virtual void	ComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
virtual void	EndComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
virtual int	ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *callData, int modify=0)
virtual void	SetPlaceFactor (double)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
virtual double	GetPlaceFactor ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
virtual double	GetHandleSize ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
virtual vtkTypeBool	GetNeedToRender ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
virtual void	SetNeedToRender (vtkTypeBool)
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
virtual void	NeedToRenderOn ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
virtual void	NeedToRenderOff ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
vtkWidgetRepresentation *	NewInstance () const
	Standard methods for instances of this class.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instances of this class.
Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.
virtual void	GetActors2D (vtkPropCollection *)
virtual void	GetVolumes (vtkPropCollection *)
virtual void	Pick ()
	Method fires PickEvent if the prop is picked.
virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.
virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.
virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
virtual vtkMatrix4x4 *	GetMatrix ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.
virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	RenderVolumetricGeometry (vtkViewport *)
virtual int	RenderOverlay (vtkViewport *)
virtual bool	RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.
virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.
virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.
virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.
virtual double	GetEstimatedRenderTime ()
virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.
virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.
virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.
void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.
virtual double	GetRenderTimeMultiplier ()
virtual void	BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.
virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.
virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers
virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.
virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.
virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.
virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.
virtual void	PickableOn ()
	Set/Get the pickable instance variable.
virtual void	PickableOff ()
	Set/Get the pickable instance variable.
virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.
virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.
virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.
virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.
virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.
virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
virtual int	GetNumberOfConsumers ()
	Get the number of consumers.
void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.
int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.
virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.
virtual bool	IsRenderingTranslucentPolygonalGeometry ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkCamera3DRepresentation *	New ()
	Instantiate the class.
Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class.
static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class.
Static Public Member Functions inherited from vtkProp
static vtkTypeBool	IsTypeOf (const char *type)
static vtkProp *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.
static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkCamera3DRepresentation ()
	~vtkCamera3DRepresentation () override
virtual void	CreateDefaultProperties ()
virtual void	UpdateGeometry ()
void	HighlightHandle (vtkProp *prop)
virtual void	TranslateAll (const double p1[4], const double p2[4])
virtual void	TranslatePosition (const double p1[4], const double p2[4])
virtual void	TranslateTarget (const double p1[4], const double p2[4])
virtual void	TranslateNearTarget (const double p1[4], const double p2[4])
virtual void	TranslateUp (const double p1[4], const double p2[4])
virtual void	Scale (const double p1[4], const double p2[4], int X, int Y)
void	GetTranslation (const double p1[4], const double p2[4], double v[3])
Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()
	~vtkWidgetRepresentation () override
vtkVector3d	GetWorldPoint (vtkAbstractPicker *picker, double screenPos[2])
	Return the given screen point in world coordinates, based on picked position.
void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])
vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the widget representation currently belong.
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path.
vtkAssemblyPath *	GetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)
bool	NearbyEvent (int X, int Y, double bounds[6])
double	SizeHandlesRelativeToViewport (double factor, double pos[3])
double	SizeHandlesInPixels (double factor, double pos[3])
void	UpdatePropPose (vtkProp3D *prop, const double *pos1, const double *orient1, const double *pos2, const double *orient2)
Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkProp ()
	~vtkProp () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	LastEventPosition [3] = { 0.0 }
double	LastEventOrientation [4] = { 0.0 }
double	StartEventOrientation [4] = { 0.0 }
vtkSmartPointer< vtkCamera >	Camera
vtkNew< vtkCameraActor >	CameraFrustumActor
vtkNew< vtkTransform >	CameraTransform
vtkNew< vtkTransform >	FrontTransform
vtkNew< vtkTransform >	UpTransform
vtkNew< vtkActor >	CameraBoxActor
vtkNew< vtkActor >	CameraConeActor
double	FrontHandleDistance = 2.5
double	UpHandleDistance = 1.5
std::array< vtkNew< vtkActor >, 3 >	HandleSphereActor
std::array< vtkNew< vtkSphereSource >, 3 >	HandleSphereGeometry
std::array< vtkNew< vtkActor >, 2 >	HandleLineActor
std::array< vtkNew< vtkLineSource >, 2 >	HandleLineGeometry
vtkNew< vtkProperty >	HandleProperty
vtkNew< vtkProperty >	SelectedHandleProperty
vtkNew< vtkCellPicker >	HandlePicker
vtkProp *	CurrentHandle = nullptr
vtkNew< vtkBox >	BoundingBox
int	TranslationAxis = Axis::NONE
bool	TranslatingAll = false
bool	FrustumVisibility = true
bool	SecondaryHandlesVisibility = true
Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRenderer >	Renderer
int	InteractionState
double	StartEventPosition [3]
double	PlaceFactor
int	Placed
double	InitialBounds [6]
double	InitialLength
int	ValidPick
bool	PickingManaged
double	HandleSize
vtkTypeBool	NeedToRender
vtkTimeStamp	BuildTime
vtkNew< vtkTransform >	TempTransform
vtkNew< vtkMatrix4x4 >	TempMatrix
Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility
vtkTypeBool	Pickable
vtkTypeBool	Dragable
bool	UseBounds
double	AllocatedRenderTime
double	EstimatedRenderTime
double	SavedEstimatedRenderTime
double	RenderTimeMultiplier
int	NumberOfConsumers
vtkObject **	Consumers
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
vtkShaderProperty *	ShaderProperty
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkWidgetRepresentation	Superclass
	Standard methods for the class.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for the class.
static vtkCamera3DRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for the class.
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for the class.
vtkCamera3DRepresentation *	NewInstance () const
	Standard methods for the class.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for the class.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for the class.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a class defining the representation for the vtkCamera3DWidget

This class is a concrete representation for the vtkCamera3DWidget. The camera is represented by a box and a cone. The first one allows camera movement, the second allows view angle update. There are three more handles to rotate the view up, and move the target position. It also has a frustum representation.

To use this representation, you can use the PlaceWidget() method to position the widget looking at a specified region in space. This is optional as you may want to not move the camera at setup.

See also

vtkCamera3DWidget

Tests:

vtkCamera3DRepresentation (Tests)

Definition at line 47 of file vtkCamera3DRepresentation.h.

Member Typedef Documentation

Superclass

typedef vtkWidgetRepresentation vtkCamera3DRepresentation::Superclass

Standard methods for the class.

Definition at line 60 of file vtkCamera3DRepresentation.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
Outside
Translating
TranslatingPosition
TranslatingNearTarget
TranslatingTarget
TranslatingUp
Scaling

Definition at line 181 of file vtkCamera3DRepresentation.h.

Constructor & Destructor Documentation

vtkCamera3DRepresentation()

vtkCamera3DRepresentation::vtkCamera3DRepresentation ( )

protected

~vtkCamera3DRepresentation()

vtkCamera3DRepresentation::~vtkCamera3DRepresentation ( )

overrideprotected

Member Function Documentation

New()

static vtkCamera3DRepresentation * vtkCamera3DRepresentation::New ( )

static

Instantiate the class.

IsTypeOf()

static vtkTypeBool vtkCamera3DRepresentation::IsTypeOf ( const char *  type )

static

Standard methods for the class.

IsA()

virtual vtkTypeBool vtkCamera3DRepresentation::IsA ( const char *  type )

virtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

SafeDownCast()

static vtkCamera3DRepresentation * vtkCamera3DRepresentation::SafeDownCast ( vtkObjectBase *  o )

static

Standard methods for the class.

NewInstanceInternal()

virtual vtkObjectBase * vtkCamera3DRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

NewInstance()

vtkCamera3DRepresentation * vtkCamera3DRepresentation::NewInstance

(

)

const

Standard methods for the class.

PrintSelf()

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

overridevirtual

Standard methods for the class.

Reimplemented from vtkObjectBase.

PlaceWidget()

void vtkCamera3DRepresentation::PlaceWidget ( double  bounds[6] )

override

These are methods that satisfy vtkWidgetRepresentation's API.

BuildRepresentation()

void vtkCamera3DRepresentation::BuildRepresentation ( )

overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Implements vtkWidgetRepresentation.

ComputeInteractionState()

int vtkCamera3DRepresentation::ComputeInteractionState ( int  X, int  Y, int  modify = 0  )

overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

StartWidgetInteraction()

void vtkCamera3DRepresentation::StartWidgetInteraction ( double  e[2] )

overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

WidgetInteraction()

void vtkCamera3DRepresentation::WidgetInteraction ( double  e[2] )

overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

GetBounds()

double * vtkCamera3DRepresentation::GetBounds ( )

overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkProp.

ReleaseGraphicsResources()

void vtkCamera3DRepresentation::ReleaseGraphicsResources ( vtkWindow *  )

overridevirtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

RenderOpaqueGeometry()

int vtkCamera3DRepresentation::RenderOpaqueGeometry ( vtkViewport *  )

overridevirtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

RenderTranslucentPolygonalGeometry()

int vtkCamera3DRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport *  )

overridevirtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

HasTranslucentPolygonalGeometry()

vtkTypeBool vtkCamera3DRepresentation::HasTranslucentPolygonalGeometry ( )

overridevirtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

SetCamera()

virtual void vtkCamera3DRepresentation::SetCamera ( vtkCamera *  camera )

virtual

Set/Get the camera.

GetCamera()

vtkCamera * vtkCamera3DRepresentation::GetCamera

(

)

Set/Get the camera.

SetFrontHandleDistance()

virtual void vtkCamera3DRepresentation::SetFrontHandleDistance ( double  )

virtual

Set/Get the distance between camera position and the front handle.

Note that the distance is scaled with view to keep the widget the same size. Default: 2.5.

GetFrontHandleDistance()

virtual double vtkCamera3DRepresentation::GetFrontHandleDistance ( )

virtual

Set/Get the distance between camera position and the front handle.

Note that the distance is scaled with view to keep the widget the same size. Default: 2.5.

SetUpHandleDistance()

virtual void vtkCamera3DRepresentation::SetUpHandleDistance ( double  )

virtual

Set/Get the distance between camera position and the up handle.

Note that the distance is scaled with view to keep the widget the same size. Default: 1.5.

GetUpHandleDistance()

virtual double vtkCamera3DRepresentation::GetUpHandleDistance ( )

virtual

Set/Get the distance between camera position and the up handle.

Note that the distance is scaled with view to keep the widget the same size. Default: 1.5.

SetTranslationAxisToXAxis()

void vtkCamera3DRepresentation::SetTranslationAxisToXAxis ( )

inline

Set/Get the constraint axis for translations.

Default: Axis::NONE (-1).

Definition at line 119 of file vtkCamera3DRepresentation.h.

SetTranslationAxisToYAxis()

void vtkCamera3DRepresentation::SetTranslationAxisToYAxis ( )

inline

Set/Get the constraint axis for translations.

Default: Axis::NONE (-1).

Definition at line 120 of file vtkCamera3DRepresentation.h.

SetTranslationAxisToZAxis()

void vtkCamera3DRepresentation::SetTranslationAxisToZAxis ( )

inline

Set/Get the constraint axis for translations.

Default: Axis::NONE (-1).

Definition at line 121 of file vtkCamera3DRepresentation.h.

SetTranslationAxisToNone()

void vtkCamera3DRepresentation::SetTranslationAxisToNone ( )

inline

Set/Get the constraint axis for translations.

Default: Axis::NONE (-1).

Definition at line 122 of file vtkCamera3DRepresentation.h.

SetTranslationAxis()

virtual void vtkCamera3DRepresentation::SetTranslationAxis ( int  )

virtual

Set/Get the constraint axis for translations.

Default: Axis::NONE (-1).

GetTranslationAxis()

virtual int vtkCamera3DRepresentation::GetTranslationAxis ( )

virtual

Set/Get the constraint axis for translations.

Default: Axis::NONE (-1).

SetTranslatingAll()

virtual void vtkCamera3DRepresentation::SetTranslatingAll ( bool  )

virtual

Set/Get whether to translate both position and target or not.

Default: false.

GetTranslatingAll()

virtual bool vtkCamera3DRepresentation::GetTranslatingAll ( )

virtual

Set/Get whether to translate both position and target or not.

Default: false.

TranslatingAllOn()

virtual void vtkCamera3DRepresentation::TranslatingAllOn ( )

virtual

Set/Get whether to translate both position and target or not.

Default: false.

TranslatingAllOff()

virtual void vtkCamera3DRepresentation::TranslatingAllOff ( )

virtual

Set/Get whether to translate both position and target or not.

Default: false.

SetFrustumVisibility()

void vtkCamera3DRepresentation::SetFrustumVisibility

(

bool

visible

)

Set/Get whether to show camera frustum.

Default: true.

GetFrustumVisibility()

virtual bool vtkCamera3DRepresentation::GetFrustumVisibility ( )

virtual

Set/Get whether to show camera frustum.

Default: true.

FrustumVisibilityOn()

virtual void vtkCamera3DRepresentation::FrustumVisibilityOn ( )

virtual

Set/Get whether to show camera frustum.

Default: true.

FrustumVisibilityOff()

virtual void vtkCamera3DRepresentation::FrustumVisibilityOff ( )

virtual

Set/Get whether to show camera frustum.

Default: true.

SetSecondaryHandlesVisibility()

void vtkCamera3DRepresentation::SetSecondaryHandlesVisibility

(

bool

visible

)

Set/Get whether to show secondary handles (spheres and lines).

Default: true.

GetSecondaryHandlesVisibility()

virtual bool vtkCamera3DRepresentation::GetSecondaryHandlesVisibility ( )

virtual

Set/Get whether to show secondary handles (spheres and lines).

Default: true.

SecondaryHandlesVisibilityOn()

virtual void vtkCamera3DRepresentation::SecondaryHandlesVisibilityOn ( )

virtual

Set/Get whether to show secondary handles (spheres and lines).

Default: true.

SecondaryHandlesVisibilityOff()

virtual void vtkCamera3DRepresentation::SecondaryHandlesVisibilityOff ( )

virtual

Set/Get whether to show secondary handles (spheres and lines).

Default: true.

SetInteractionState()

void vtkCamera3DRepresentation::SetInteractionState

(

int

state

)

The interaction state may be set from a widget (e.g., vtkCamera3DWidget) or other object.

This controls how the interaction with the widget proceeds. Normally this method is used as part of a handshaking process with the widget: First ComputeInteractionState() is invoked that returns a state based on geometric considerations (i.e., cursor near a widget feature), then based on events, the widget may modify this further.

RegisterPickers()

void vtkCamera3DRepresentation::RegisterPickers ( )

overridevirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widget representations to register their pickers.

Reimplemented from vtkWidgetRepresentation.

GetActors()

void vtkCamera3DRepresentation::GetActors ( vtkPropCollection *  )

overridevirtual

These methods are necessary to make this representation behave as a vtkProp (i.e., support rendering).

GetActors adds all the internal props used by this representation to the supplied collection.

Reimplemented from vtkProp.

CreateDefaultProperties()

virtual void vtkCamera3DRepresentation::CreateDefaultProperties ( )

protectedvirtual

UpdateGeometry()

virtual void vtkCamera3DRepresentation::UpdateGeometry ( )

protectedvirtual

HighlightHandle()

void vtkCamera3DRepresentation::HighlightHandle ( vtkProp *  prop )

protected

TranslateAll()

virtual void vtkCamera3DRepresentation::TranslateAll ( const double  p1[4], const double  p2[4]  )

protectedvirtual

TranslatePosition()

virtual void vtkCamera3DRepresentation::TranslatePosition ( const double  p1[4], const double  p2[4]  )

protectedvirtual

TranslateTarget()

virtual void vtkCamera3DRepresentation::TranslateTarget ( const double  p1[4], const double  p2[4]  )

protectedvirtual

TranslateNearTarget()

virtual void vtkCamera3DRepresentation::TranslateNearTarget ( const double  p1[4], const double  p2[4]  )

protectedvirtual

TranslateUp()

virtual void vtkCamera3DRepresentation::TranslateUp ( const double  p1[4], const double  p2[4]  )

protectedvirtual

Scale()

virtual void vtkCamera3DRepresentation::Scale ( const double  p1[4], const double  p2[4], int  X, int  Y  )

protectedvirtual

GetTranslation()

void vtkCamera3DRepresentation::GetTranslation ( const double  p1[4], const double  p2[4], double  v[3]  )

protected

Member Data Documentation

LastEventPosition

double vtkCamera3DRepresentation::LastEventPosition[3] = { 0.0 }

protected

Definition at line 210 of file vtkCamera3DRepresentation.h.

LastEventOrientation

double vtkCamera3DRepresentation::LastEventOrientation[4] = { 0.0 }

protected

Definition at line 211 of file vtkCamera3DRepresentation.h.

StartEventOrientation

double vtkCamera3DRepresentation::StartEventOrientation[4] = { 0.0 }

protected

Definition at line 212 of file vtkCamera3DRepresentation.h.

Camera

vtkSmartPointer<vtkCamera> vtkCamera3DRepresentation::Camera

protected

Definition at line 215 of file vtkCamera3DRepresentation.h.

CameraFrustumActor

vtkNew<vtkCameraActor> vtkCamera3DRepresentation::CameraFrustumActor

protected

Definition at line 216 of file vtkCamera3DRepresentation.h.

CameraTransform

vtkNew<vtkTransform> vtkCamera3DRepresentation::CameraTransform

protected

Definition at line 217 of file vtkCamera3DRepresentation.h.

FrontTransform

vtkNew<vtkTransform> vtkCamera3DRepresentation::FrontTransform

protected

Definition at line 218 of file vtkCamera3DRepresentation.h.

UpTransform

vtkNew<vtkTransform> vtkCamera3DRepresentation::UpTransform

protected

Definition at line 219 of file vtkCamera3DRepresentation.h.

CameraBoxActor

vtkNew<vtkActor> vtkCamera3DRepresentation::CameraBoxActor

protected

Definition at line 220 of file vtkCamera3DRepresentation.h.

CameraConeActor

vtkNew<vtkActor> vtkCamera3DRepresentation::CameraConeActor

protected

Definition at line 221 of file vtkCamera3DRepresentation.h.

FrontHandleDistance

double vtkCamera3DRepresentation::FrontHandleDistance = 2.5

protected

Definition at line 224 of file vtkCamera3DRepresentation.h.

UpHandleDistance

double vtkCamera3DRepresentation::UpHandleDistance = 1.5

protected

Definition at line 225 of file vtkCamera3DRepresentation.h.

HandleSphereActor

std::array<vtkNew<vtkActor>, 3> vtkCamera3DRepresentation::HandleSphereActor

protected

Definition at line 226 of file vtkCamera3DRepresentation.h.

HandleSphereGeometry

std::array<vtkNew<vtkSphereSource>, 3> vtkCamera3DRepresentation::HandleSphereGeometry

protected

Definition at line 227 of file vtkCamera3DRepresentation.h.

HandleLineActor

std::array<vtkNew<vtkActor>, 2> vtkCamera3DRepresentation::HandleLineActor

protected

Definition at line 228 of file vtkCamera3DRepresentation.h.

HandleLineGeometry

std::array<vtkNew<vtkLineSource>, 2> vtkCamera3DRepresentation::HandleLineGeometry

protected

Definition at line 229 of file vtkCamera3DRepresentation.h.

HandleProperty

vtkNew<vtkProperty> vtkCamera3DRepresentation::HandleProperty

protected

Definition at line 233 of file vtkCamera3DRepresentation.h.

SelectedHandleProperty

vtkNew<vtkProperty> vtkCamera3DRepresentation::SelectedHandleProperty

protected

Definition at line 234 of file vtkCamera3DRepresentation.h.

HandlePicker

vtkNew<vtkCellPicker> vtkCamera3DRepresentation::HandlePicker

protected

Definition at line 237 of file vtkCamera3DRepresentation.h.

CurrentHandle

vtkProp* vtkCamera3DRepresentation::CurrentHandle = nullptr

protected

Definition at line 238 of file vtkCamera3DRepresentation.h.

BoundingBox

vtkNew<vtkBox> vtkCamera3DRepresentation::BoundingBox

protected

Definition at line 241 of file vtkCamera3DRepresentation.h.

TranslationAxis

int vtkCamera3DRepresentation::TranslationAxis = Axis::NONE

protected

Definition at line 243 of file vtkCamera3DRepresentation.h.

TranslatingAll

bool vtkCamera3DRepresentation::TranslatingAll = false

protected

Definition at line 244 of file vtkCamera3DRepresentation.h.

FrustumVisibility

bool vtkCamera3DRepresentation::FrustumVisibility = true

protected

Definition at line 245 of file vtkCamera3DRepresentation.h.

SecondaryHandlesVisibility

bool vtkCamera3DRepresentation::SecondaryHandlesVisibility = true

protected

Definition at line 246 of file vtkCamera3DRepresentation.h.

---

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

• Interaction/Widgets/vtkCamera3DRepresentation.h