VTK  9.1.20211115
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkMagnifierRepresentation Class Reference

represent a vtkBorderWidget More...

#include <vtkMagnifierRepresentation.h>

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

Public Types

enum  _InteractionState { Invisible = 0 , Visible }
 Define the various states that the representation can be in. More...
 
- Public Types inherited from vtkWidgetRepresentation
enum  Axis { NONE = -1 , XAxis = 0 , YAxis = 1 , ZAxis = 2 }
 Axis labels. More...
 
typedef vtkProp Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual void SetInteractionState (int)
 Specify the interaction state of the widget. More...
 
vtkRendererGetMagnificationRenderer ()
 Provide access to the magnification renderer. More...
 
vtkMTimeType GetMTime () override
 Return the MTime of this object. More...
 
void SetRenderer (vtkRenderer *ren) override
 Specify the renderer viewport in which to place the magnifier. More...
 
virtual void SetMagnificationFactor (double)
 Methods to control the magnification factor. More...
 
virtual double GetMagnificationFactor ()
 Methods to control the magnification factor. More...
 
void AddViewProp (vtkProp *)
 Optionally specify and maintain the list of view props (e.g., actors, volumes, etc). More...
 
vtkPropCollectionGetViewProps ()
 Optionally specify and maintain the list of view props (e.g., actors, volumes, etc). More...
 
int HasViewProp (vtkProp *)
 Optionally specify and maintain the list of view props (e.g., actors, volumes, etc). More...
 
void RemoveViewProp (vtkProp *)
 Optionally specify and maintain the list of view props (e.g., actors, volumes, etc). More...
 
void RemoveAllViewProps (void)
 Optionally specify and maintain the list of view props (e.g., actors, volumes, etc). More...
 
virtual void SetSize (int, int)
 Specify the size of the magnifier viewport in pixels. More...
 
void SetSize (int[2])
 Optionally specify and maintain the list of view props (e.g., actors, volumes, etc). More...
 
virtual int * GetSize ()
 Optionally specify and maintain the list of view props (e.g., actors, volumes, etc). More...
 
virtual void GetSize (int &, int &)
 Optionally specify and maintain the list of view props (e.g., actors, volumes, etc). More...
 
virtual void GetSize (int[2])
 Optionally specify and maintain the list of view props (e.g., actors, volumes, etc). More...
 
virtual void SetBorder (bool)
 Optionally specify whether a border should be drawn on the outer edge of the magnifier viewport. More...
 
virtual bool GetBorder ()
 Optionally specify whether a border should be drawn on the outer edge of the magnifier viewport. More...
 
virtual void BorderOn ()
 Optionally specify whether a border should be drawn on the outer edge of the magnifier viewport. More...
 
virtual void BorderOff ()
 Optionally specify whether a border should be drawn on the outer edge of the magnifier viewport. More...
 
virtual vtkProperty2DGetBorderProperty ()
 Specify the properties of the border. More...
 
void BuildRepresentation () override
 Subclasses should implement these methods. More...
 
void WidgetInteraction (double eventPos[2]) override
 Subclasses should implement these methods. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
int RenderOverlay (vtkViewport *) override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
int RenderOpaqueGeometry (vtkViewport *) override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void PlaceWidget (double vtkNotUsed(bounds)[6])
 The following is a suggested API for widget representations. More...
 
virtual void StartWidgetInteraction (double eventPos[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. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp. More...
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
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. More...
 
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. More...
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
virtual void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 Enable/Disable the use of a manager to process the picking. More...
 
void SetPickingManaged (bool managed)
 Enable/Disable the use of a manager to process the picking. More...
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual vtkRendererGetRenderer ()
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
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). More...
 
virtual double GetPlaceFactor ()
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual void SetHandleSize (double)
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...
 
virtual double GetHandleSize ()
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
vtkWidgetRepresentationNewInstance () const
 Standard methods for instances of this class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. More...
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOn ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOff ()
 Set/Get the pickable instance variable. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. More...
 
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(). More...
 
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(). More...
 
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(). More...
 
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(). More...
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys. More...
 
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. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,. More...
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property. More...
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkMagnifierRepresentationNew ()
 Instantiate this class. More...
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

 vtkMagnifierRepresentation ()
 
 ~vtkMagnifierRepresentation () override
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (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. More...
 
vtkAssemblyPathGetAssemblyPath3DPoint (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
 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double MagnificationFactor
 
vtkPropCollectionProps
 
int Size [2]
 
bool Border
 
vtkProperty2DBorderProperty
 
vtkRendererMagnificationRenderer
 
vtkCoordinateCoordinate
 
bool InsideRenderer
 
vtkPointsBorderPoints
 
vtkPolyDataBorderPolyData
 
vtkPolyDataMapper2DBorderMapper
 
vtkActor2DBorderActor
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRendererRenderer
 
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< vtkTransformTempTransform
 
vtkNew< vtkMatrix4x4TempMatrix
 
- 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
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkWidgetRepresentation Superclass
 Define standard methods. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Define standard methods. More...
 
static vtkMagnifierRepresentationSafeDownCast (vtkObjectBase *o)
 Define standard methods. More...
 
virtual vtkTypeBool IsA (const char *type)
 Define standard methods. More...
 
vtkMagnifierRepresentationNewInstance () const
 Define standard methods. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Define standard methods. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Define standard methods. More...
 

Additional Inherited Members

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

Detailed Description

represent a vtkBorderWidget

This class is used to represent and render a vtkMagnifierWidget. To use this class, you need to specify a renderer in which to place the magnifier, and a magnification factor. Optionally, you can specify the size of the magnifier window, whether it has a border, and the particular actors to render.

See also
vtkMagnifierWidget

Definition at line 43 of file vtkMagnifierRepresentation.h.

Member Typedef Documentation

◆ Superclass

Define standard methods.

Definition at line 55 of file vtkMagnifierRepresentation.h.

Member Enumeration Documentation

◆ _InteractionState

Define the various states that the representation can be in.

Enumerator
Invisible 
Visible 

Definition at line 121 of file vtkMagnifierRepresentation.h.

Constructor & Destructor Documentation

◆ vtkMagnifierRepresentation()

vtkMagnifierRepresentation::vtkMagnifierRepresentation ( )
protected

◆ ~vtkMagnifierRepresentation()

vtkMagnifierRepresentation::~vtkMagnifierRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkMagnifierRepresentation* vtkMagnifierRepresentation::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

Define standard methods.

◆ IsA()

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

Define standard methods.

Reimplemented from vtkWidgetRepresentation.

◆ SafeDownCast()

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

Define standard methods.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMagnifierRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Define standard methods.

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkMagnifierRepresentation* vtkMagnifierRepresentation::NewInstance ( ) const

Define standard methods.

◆ PrintSelf()

void vtkMagnifierRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Define standard methods.

Reimplemented from vtkObject.

◆ SetRenderer()

void vtkMagnifierRepresentation::SetRenderer ( vtkRenderer ren)
inlineoverridevirtual

Specify the renderer viewport in which to place the magnifier.

Reimplemented from vtkWidgetRepresentation.

Definition at line 63 of file vtkMagnifierRepresentation.h.

◆ SetMagnificationFactor()

virtual void vtkMagnifierRepresentation::SetMagnificationFactor ( double  )
virtual

Methods to control the magnification factor.

The magnification factor is relative to the associated renderer's camera. The bump method enables small increments of magnification to be applied. If the bump is positive, it increases the magnification; if negative it decreases the magnification.

◆ GetMagnificationFactor()

virtual double vtkMagnifierRepresentation::GetMagnificationFactor ( )
virtual

Methods to control the magnification factor.

The magnification factor is relative to the associated renderer's camera. The bump method enables small increments of magnification to be applied. If the bump is positive, it increases the magnification; if negative it decreases the magnification.

◆ AddViewProp()

void vtkMagnifierRepresentation::AddViewProp ( vtkProp )

Optionally specify and maintain the list of view props (e.g., actors, volumes, etc).

By default, if nothing is specified, then the view props from the associated renderer are used. Note, by using view props different than that of the associated renderer, it is possible to create special effects and/or remove props from what is shown in the magnifier.

◆ GetViewProps()

vtkPropCollection* vtkMagnifierRepresentation::GetViewProps ( )
inline

Optionally specify and maintain the list of view props (e.g., actors, volumes, etc).

By default, if nothing is specified, then the view props from the associated renderer are used. Note, by using view props different than that of the associated renderer, it is possible to create special effects and/or remove props from what is shown in the magnifier.

Definition at line 87 of file vtkMagnifierRepresentation.h.

◆ HasViewProp()

int vtkMagnifierRepresentation::HasViewProp ( vtkProp )

Optionally specify and maintain the list of view props (e.g., actors, volumes, etc).

By default, if nothing is specified, then the view props from the associated renderer are used. Note, by using view props different than that of the associated renderer, it is possible to create special effects and/or remove props from what is shown in the magnifier.

◆ RemoveViewProp()

void vtkMagnifierRepresentation::RemoveViewProp ( vtkProp )

Optionally specify and maintain the list of view props (e.g., actors, volumes, etc).

By default, if nothing is specified, then the view props from the associated renderer are used. Note, by using view props different than that of the associated renderer, it is possible to create special effects and/or remove props from what is shown in the magnifier.

◆ RemoveAllViewProps()

void vtkMagnifierRepresentation::RemoveAllViewProps ( void  )

Optionally specify and maintain the list of view props (e.g., actors, volumes, etc).

By default, if nothing is specified, then the view props from the associated renderer are used. Note, by using view props different than that of the associated renderer, it is possible to create special effects and/or remove props from what is shown in the magnifier.

◆ SetSize() [1/2]

virtual void vtkMagnifierRepresentation::SetSize ( int  ,
int   
)
virtual

Specify the size of the magnifier viewport in pixels.

◆ SetSize() [2/2]

void vtkMagnifierRepresentation::SetSize ( int  [2])

Optionally specify and maintain the list of view props (e.g., actors, volumes, etc).

By default, if nothing is specified, then the view props from the associated renderer are used. Note, by using view props different than that of the associated renderer, it is possible to create special effects and/or remove props from what is shown in the magnifier.

◆ GetSize() [1/3]

virtual int* vtkMagnifierRepresentation::GetSize ( )
virtual

Optionally specify and maintain the list of view props (e.g., actors, volumes, etc).

By default, if nothing is specified, then the view props from the associated renderer are used. Note, by using view props different than that of the associated renderer, it is possible to create special effects and/or remove props from what is shown in the magnifier.

◆ GetSize() [2/3]

virtual void vtkMagnifierRepresentation::GetSize ( int &  ,
int &   
)
virtual

Optionally specify and maintain the list of view props (e.g., actors, volumes, etc).

By default, if nothing is specified, then the view props from the associated renderer are used. Note, by using view props different than that of the associated renderer, it is possible to create special effects and/or remove props from what is shown in the magnifier.

◆ GetSize() [3/3]

virtual void vtkMagnifierRepresentation::GetSize ( int  [2])
virtual

Optionally specify and maintain the list of view props (e.g., actors, volumes, etc).

By default, if nothing is specified, then the view props from the associated renderer are used. Note, by using view props different than that of the associated renderer, it is possible to create special effects and/or remove props from what is shown in the magnifier.

◆ SetBorder()

virtual void vtkMagnifierRepresentation::SetBorder ( bool  )
virtual

Optionally specify whether a border should be drawn on the outer edge of the magnifier viewport.

By default this is off.

◆ GetBorder()

virtual bool vtkMagnifierRepresentation::GetBorder ( )
virtual

Optionally specify whether a border should be drawn on the outer edge of the magnifier viewport.

By default this is off.

◆ BorderOn()

virtual void vtkMagnifierRepresentation::BorderOn ( )
virtual

Optionally specify whether a border should be drawn on the outer edge of the magnifier viewport.

By default this is off.

◆ BorderOff()

virtual void vtkMagnifierRepresentation::BorderOff ( )
virtual

Optionally specify whether a border should be drawn on the outer edge of the magnifier viewport.

By default this is off.

◆ GetBorderProperty()

virtual vtkProperty2D* vtkMagnifierRepresentation::GetBorderProperty ( )
virtual

Specify the properties of the border.

◆ BuildRepresentation()

void vtkMagnifierRepresentation::BuildRepresentation ( )
overridevirtual

Subclasses should implement these methods.

See the superclasses' documentation for more information.

Implements vtkWidgetRepresentation.

◆ WidgetInteraction()

void vtkMagnifierRepresentation::WidgetInteraction ( double  eventPos[2])
overridevirtual

Subclasses should implement these methods.

See the superclasses' documentation for more information.

Reimplemented from vtkWidgetRepresentation.

◆ SetInteractionState()

virtual void vtkMagnifierRepresentation::SetInteractionState ( int  )
virtual

Specify the interaction state of the widget.

This is generally performed by the associated vtkMagnifierWidget. (It is necessary for the widget to specify the interaction state in order to remove the internal magnification renderer from the render window).

◆ GetMagnificationRenderer()

vtkRenderer* vtkMagnifierRepresentation::GetMagnificationRenderer ( )
inline

Provide access to the magnification renderer.

This is so properties like background color can be set.

Definition at line 148 of file vtkMagnifierRepresentation.h.

◆ ReleaseGraphicsResources()

void vtkMagnifierRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkProp.

◆ RenderOverlay()

int vtkMagnifierRepresentation::RenderOverlay ( vtkViewport )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkMagnifierRepresentation::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkMagnifierRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkMagnifierRepresentation::HasTranslucentPolygonalGeometry ( )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkProp.

◆ GetMTime()

vtkMTimeType vtkMagnifierRepresentation::GetMTime ( )
overridevirtual

Return the MTime of this object.

It takes into account MTimes of the border's property.

Reimplemented from vtkObject.

Member Data Documentation

◆ MagnificationFactor

double vtkMagnifierRepresentation::MagnificationFactor
protected

Definition at line 173 of file vtkMagnifierRepresentation.h.

◆ Props

vtkPropCollection* vtkMagnifierRepresentation::Props
protected

Definition at line 174 of file vtkMagnifierRepresentation.h.

◆ Size

int vtkMagnifierRepresentation::Size[2]
protected

Definition at line 175 of file vtkMagnifierRepresentation.h.

◆ Border

bool vtkMagnifierRepresentation::Border
protected

Definition at line 176 of file vtkMagnifierRepresentation.h.

◆ BorderProperty

vtkProperty2D* vtkMagnifierRepresentation::BorderProperty
protected

Definition at line 177 of file vtkMagnifierRepresentation.h.

◆ MagnificationRenderer

vtkRenderer* vtkMagnifierRepresentation::MagnificationRenderer
protected

Definition at line 180 of file vtkMagnifierRepresentation.h.

◆ Coordinate

vtkCoordinate* vtkMagnifierRepresentation::Coordinate
protected

Definition at line 181 of file vtkMagnifierRepresentation.h.

◆ InsideRenderer

bool vtkMagnifierRepresentation::InsideRenderer
protected

Definition at line 182 of file vtkMagnifierRepresentation.h.

◆ BorderPoints

vtkPoints* vtkMagnifierRepresentation::BorderPoints
protected

Definition at line 185 of file vtkMagnifierRepresentation.h.

◆ BorderPolyData

vtkPolyData* vtkMagnifierRepresentation::BorderPolyData
protected

Definition at line 186 of file vtkMagnifierRepresentation.h.

◆ BorderMapper

vtkPolyDataMapper2D* vtkMagnifierRepresentation::BorderMapper
protected

Definition at line 187 of file vtkMagnifierRepresentation.h.

◆ BorderActor

vtkActor2D* vtkMagnifierRepresentation::BorderActor
protected

Definition at line 188 of file vtkMagnifierRepresentation.h.


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