VTK  9.4.20241212
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkBoxRepresentation Class Reference

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

#include <vtkBoxRepresentation.h>

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

Public Types

enum  {
  Outside = 0 , MoveF0 , MoveF1 , MoveF2 ,
  MoveF3 , MoveF4 , MoveF5 , Translating ,
  Rotating , 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 GetPlanes (vtkPlanes *planes)
 Get the planes describing the implicit function defined by the box widget.
 
vtkPlaneGetUnderlyingPlane (int i)
 
virtual void GetTransform (vtkTransform *t)
 Retrieve a linear transform characterizing the transformation of the box.
 
virtual void SetTransform (vtkTransform *t)
 Set the position, scale and orientation of the box widget using the transform specified.
 
void GetPolyData (vtkPolyData *pd)
 Grab the polydata (including points) that define the box widget.
 
void SetInteractionState (int state)
 The interaction state may be set from a widget (e.g., vtkBoxWidget2) 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).
 
virtual void SetInsideOut (vtkTypeBool)
 Set/Get the InsideOut flag.
 
virtual vtkTypeBool GetInsideOut ()
 Set/Get the InsideOut flag.
 
virtual void InsideOutOn ()
 Set/Get the InsideOut flag.
 
virtual void InsideOutOff ()
 Set/Get the InsideOut flag.
 
virtual vtkPropertyGetHandleProperty ()
 Get the handle properties (the little balls are the handles).
 
virtual vtkPropertyGetSelectedHandleProperty ()
 Get the handle properties (the little balls are the handles).
 
virtual vtkPropertyGetFaceProperty ()
 Get the face properties (the faces of the box).
 
virtual vtkPropertyGetSelectedFaceProperty ()
 Get the face properties (the faces of the box).
 
virtual vtkPropertyGetOutlineProperty ()
 Get the outline properties (the outline of the box).
 
virtual vtkPropertyGetSelectedOutlineProperty ()
 Get the outline properties (the outline of the box).
 
void SetForegroundColor (double _arg1, double _arg2, double _arg3)
 Set the foreground color (the outline of the box).
 
void SetForegroundColor (const double _arg[3])
 Set the foreground color (the outline of the box).
 
void SetInteractionColor (double _arg1, double _arg2, double _arg3)
 Set the interaction color.
 
void SetInteractionColor (const double _arg[3])
 Set the interaction color.
 
void SetOutlineFaceWires (int)
 Control the representation of the outline.
 
virtual int GetOutlineFaceWires ()
 Control the representation of the outline.
 
void OutlineFaceWiresOn ()
 Control the representation of the outline.
 
void OutlineFaceWiresOff ()
 Control the representation of the outline.
 
void SetOutlineCursorWires (int)
 Control the representation of the outline.
 
virtual int GetOutlineCursorWires ()
 Control the representation of the outline.
 
void OutlineCursorWiresOn ()
 Control the representation of the outline.
 
void OutlineCursorWiresOff ()
 Control the representation of the outline.
 
virtual void HandlesOn ()
 Switches handles (the spheres) on or off by manipulating the underlying actor visibility.
 
virtual void HandlesOff ()
 Switches handles (the spheres) on or off by manipulating the underlying actor visibility.
 
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 StartComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
 These are methods that satisfy vtkWidgetRepresentation's API.
 
void ComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
 These are methods that satisfy vtkWidgetRepresentation's API.
 
int ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata, int modify=0) override
 These are methods that satisfy vtkWidgetRepresentation's API.
 
void EndComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) 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 bool GetTwoPlaneMode ()
 In two plane mode only the X planes are shown this is useful for defining thick slabs.
 
void SetTwoPlaneMode (bool)
 In two plane mode only the X planes are shown this is useful for defining thick slabs.
 
virtual bool GetSnapToAxes ()
 For complex events should we snap orientations to be aligned with the x y z axes.
 
virtual void SetSnapToAxes (bool)
 For complex events should we snap orientations to be aligned with the x y z axes.
 
void StepForward ()
 For complex events should we snap orientations to be aligned with the x y z axes.
 
void StepBackward ()
 For complex events should we snap orientations to be aligned with the x y z axes.
 
virtual int GetTranslationAxis ()
 Gets/Sets the constraint axis for translations.
 
virtual void SetTranslationAxis (int)
 Gets/Sets the constraint axis for translations.
 
void SetXTranslationAxisOn ()
 Toggles constraint translation axis on/off.
 
void SetYTranslationAxisOn ()
 Toggles constraint translation axis on/off.
 
void SetZTranslationAxisOn ()
 Toggles constraint translation axis on/off.
 
void SetTranslationAxisOff ()
 Toggles constraint translation axis on/off.
 
bool IsTranslationConstrained ()
 Returns true if ConstrainedAxis.
 
std::vector< double > GetCorners ()
 Get/Set the x,y,z coordinates for the corner points of the 3D box.
 
void SetCorners (std::vector< double > points)
 Get/Set the x,y,z coordinates for the corner points of the 3D box.
 
- 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 vtkRendererGetRenderer ()
 Subclasses of vtkWidgetRepresentation must implement these methods.
 
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).
 
vtkWidgetRepresentationNewInstance () 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.
 
vtkPropNewInstance () 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 vtkMatrix4x4GetMatrix ()
 
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 vtkAssemblyPathGetNextPath ()
 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 vtkInformationGetPropertyKeys ()
 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,.
 
vtkObjectGetConsumer (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 vtkShaderPropertyGetShaderProperty ()
 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.
 
vtkCommandGetCommand (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 vtkBoxRepresentationNew ()
 Instantiate the class.
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class.
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class.
 
- 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.
 
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.
 
- 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.
 
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 vtkObjectBaseNew ()
 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

 vtkBoxRepresentation ()
 
 ~vtkBoxRepresentation () override
 
virtual void PositionHandles ()
 
int HighlightHandle (vtkProp *prop)
 
void HighlightFace (int cellId)
 
void HighlightOutline (int highlight)
 
virtual void ComputeNormals ()
 
virtual void SizeHandles ()
 
virtual void CreateDefaultProperties ()
 
void GenerateOutline ()
 
virtual void Translate (const double *p1, const double *p2)
 
virtual void Scale (const double *p1, const double *p2, int X, int Y)
 
virtual void Rotate (int X, int Y, const double *p1, const double *p2, const double *vpn)
 
void MovePlusXFace (const double *p1, const double *p2)
 
void MoveMinusXFace (const double *p1, const double *p2)
 
void MovePlusYFace (const double *p1, const double *p2)
 
void MoveMinusYFace (const double *p1, const double *p2)
 
void MovePlusZFace (const double *p1, const double *p2)
 
void MoveMinusZFace (const double *p1, const double *p2)
 
void UpdatePose (const double *p1, const double *d1, const double *p2, const double *d2)
 
void MoveFace (const double *p1, const double *p2, const double *dir, double *x1, double *x2, double *x3, double *x4, double *x5)
 
void GetDirection (const double Nx[3], const double Ny[3], const double Nz[3], double dir[3])
 
- 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.
 
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.
 
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
virtual vtkObjectBaseNewInstanceInternal () 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]
 
double LastEventOrientation [4]
 
double StartEventOrientation [4]
 
double SnappedEventOrientations [3][4]
 
bool SnappedOrientation [3]
 
bool SnapToAxes
 
bool TwoPlaneMode
 
int TranslationAxis
 
vtkActorHexActor
 
vtkPolyDataMapperHexMapper
 
vtkPolyDataHexPolyData
 
vtkPointsPoints
 
double N [6][3]
 
vtkActorHexFace
 
vtkPolyDataMapperHexFaceMapper
 
vtkPolyDataHexFacePolyData
 
vtkActor ** Handle
 
vtkPolyDataMapper ** HandleMapper
 
vtkSphereSource ** HandleGeometry
 
vtkActorHexOutline
 
vtkPolyDataMapperOutlineMapper
 
vtkPolyDataOutlinePolyData
 
vtkCellPickerHandlePicker
 
vtkCellPickerHexPicker
 
vtkActorCurrentHandle
 
int CurrentHexFace
 
vtkCellPickerLastPicker
 
vtkTransformTransform
 
vtkBoxBoundingBox
 
vtkPropertyHandleProperty
 
vtkPropertySelectedHandleProperty
 
vtkPropertyFaceProperty
 
vtkPropertySelectedFaceProperty
 
vtkPropertyOutlineProperty
 
vtkPropertySelectedOutlineProperty
 
vtkTypeBool InsideOut
 
int OutlineFaceWires
 
int OutlineCursorWires
 
vtkPointsPlanePoints
 
vtkDoubleArrayPlaneNormals
 
vtkMatrix4x4Matrix
 
vtkPlanePlanes [6]
 
- 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
 
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 vtkBoxRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for the class.
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for the class.
 
vtkBoxRepresentationNewInstance () const
 Standard methods for the class.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for the class.
 
virtual vtkObjectBaseNewInstanceInternal () 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 vtkBoxWidget2

This class is a concrete representation for the vtkBoxWidget2. It represents a box with seven handles: one on each of the six faces, plus a center handle. Through interaction with the widget, the box representation can be arbitrarily positioned in the 3D space.

To use this representation, you normally use the PlaceWidget() method to position the widget at a specified region in space.

Warning
This class, and vtkBoxWidget2, are second generation VTK widgets. An earlier version of this functionality was defined in the class vtkBoxWidget.
See also
vtkBoxWidget2 vtkBoxWidget
Online Examples:

Tests:
vtkBoxRepresentation (Tests)

Definition at line 71 of file vtkBoxRepresentation.h.

Member Typedef Documentation

◆ Superclass

Standard methods for the class.

Definition at line 84 of file vtkBoxRepresentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
Outside 
MoveF0 
MoveF1 
MoveF2 
MoveF3 
MoveF4 
MoveF5 
Translating 
Rotating 
Scaling 

Definition at line 261 of file vtkBoxRepresentation.h.

Constructor & Destructor Documentation

◆ vtkBoxRepresentation()

vtkBoxRepresentation::vtkBoxRepresentation ( )
protected

◆ ~vtkBoxRepresentation()

vtkBoxRepresentation::~vtkBoxRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBoxRepresentation * vtkBoxRepresentation::New ( )
static

Instantiate the class.

◆ IsTypeOf()

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

Standard methods for the class.

◆ IsA()

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

◆ SafeDownCast()

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

Standard methods for the class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkBoxRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkBoxRepresentation * vtkBoxRepresentation::NewInstance ( ) const

Standard methods for the class.

◆ PrintSelf()

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

Standard methods for the class.

Reimplemented from vtkObjectBase.

◆ GetPlanes()

void vtkBoxRepresentation::GetPlanes ( vtkPlanes planes)

Get the planes describing the implicit function defined by the box widget.

The user must provide the instance of the class vtkPlanes. Note that vtkPlanes is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data. (The direction of the normals of the planes can be reversed enabling the InsideOut flag.)

◆ GetUnderlyingPlane()

vtkPlane * vtkBoxRepresentation::GetUnderlyingPlane ( int  i)
inline

Definition at line 100 of file vtkBoxRepresentation.h.

◆ SetInsideOut()

virtual void vtkBoxRepresentation::SetInsideOut ( vtkTypeBool  )
virtual

Set/Get the InsideOut flag.

This data member is used in conjunction with the GetPlanes() method. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

◆ GetInsideOut()

virtual vtkTypeBool vtkBoxRepresentation::GetInsideOut ( )
virtual

Set/Get the InsideOut flag.

This data member is used in conjunction with the GetPlanes() method. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

◆ InsideOutOn()

virtual void vtkBoxRepresentation::InsideOutOn ( )
virtual

Set/Get the InsideOut flag.

This data member is used in conjunction with the GetPlanes() method. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

◆ InsideOutOff()

virtual void vtkBoxRepresentation::InsideOutOff ( )
virtual

Set/Get the InsideOut flag.

This data member is used in conjunction with the GetPlanes() method. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

◆ GetTransform()

virtual void vtkBoxRepresentation::GetTransform ( vtkTransform t)
virtual

Retrieve a linear transform characterizing the transformation of the box.

Note that the transformation is relative to where PlaceWidget() was initially called. This method modifies the transform provided. The transform can be used to control the position of vtkProp3D's, as well as other transformation operations (e.g., vtkTransformPolyData).

◆ SetTransform()

virtual void vtkBoxRepresentation::SetTransform ( vtkTransform t)
virtual

Set the position, scale and orientation of the box widget using the transform specified.

Note that the transformation is relative to where PlaceWidget() was initially called (i.e., the original bounding box).

◆ GetPolyData()

void vtkBoxRepresentation::GetPolyData ( vtkPolyData pd)

Grab the polydata (including points) that define the box widget.

The polydata consists of 6 quadrilateral faces and 15 points. The first eight points define the eight corner vertices; the next six define the -x,+x, -y,+y, -z,+z face points; and the final point (the 15th out of 15 points) defines the center of the box. These point values are guaranteed to be up-to-date when either the widget's corresponding InteractionEvent or EndInteractionEvent events are invoked. The user provides the vtkPolyData and the points and cells are added to it.

◆ GetHandleProperty()

virtual vtkProperty * vtkBoxRepresentation::GetHandleProperty ( )
virtual

Get the handle properties (the little balls are the handles).

The properties of the handles, when selected or normal, can be specified.

◆ GetSelectedHandleProperty()

virtual vtkProperty * vtkBoxRepresentation::GetSelectedHandleProperty ( )
virtual

Get the handle properties (the little balls are the handles).

The properties of the handles, when selected or normal, can be specified.

◆ GetFaceProperty()

virtual vtkProperty * vtkBoxRepresentation::GetFaceProperty ( )
virtual

Get the face properties (the faces of the box).

The properties of the face when selected and normal can be set.

◆ GetSelectedFaceProperty()

virtual vtkProperty * vtkBoxRepresentation::GetSelectedFaceProperty ( )
virtual

Get the face properties (the faces of the box).

The properties of the face when selected and normal can be set.

◆ GetOutlineProperty()

virtual vtkProperty * vtkBoxRepresentation::GetOutlineProperty ( )
virtual

Get the outline properties (the outline of the box).

The properties of the outline when selected and normal can be set.

◆ GetSelectedOutlineProperty()

virtual vtkProperty * vtkBoxRepresentation::GetSelectedOutlineProperty ( )
virtual

Get the outline properties (the outline of the box).

The properties of the outline when selected and normal can be set.

◆ SetForegroundColor() [1/2]

void vtkBoxRepresentation::SetForegroundColor ( double  _arg1,
double  _arg2,
double  _arg3 
)

Set the foreground color (the outline of the box).

◆ SetForegroundColor() [2/2]

void vtkBoxRepresentation::SetForegroundColor ( const double  _arg[3])
inline

Set the foreground color (the outline of the box).

Definition at line 180 of file vtkBoxRepresentation.h.

◆ SetInteractionColor() [1/2]

void vtkBoxRepresentation::SetInteractionColor ( double  _arg1,
double  _arg2,
double  _arg3 
)

Set the interaction color.

Applies to the handle and outline when interaction is happening.

◆ SetInteractionColor() [2/2]

void vtkBoxRepresentation::SetInteractionColor ( const double  _arg[3])
inline

Set the interaction color.

Applies to the handle and outline when interaction is happening.

Definition at line 192 of file vtkBoxRepresentation.h.

◆ SetOutlineFaceWires()

void vtkBoxRepresentation::SetOutlineFaceWires ( int  )

Control the representation of the outline.

This flag enables face wires. By default face wires are off.

◆ GetOutlineFaceWires()

virtual int vtkBoxRepresentation::GetOutlineFaceWires ( )
virtual

Control the representation of the outline.

This flag enables face wires. By default face wires are off.

◆ OutlineFaceWiresOn()

void vtkBoxRepresentation::OutlineFaceWiresOn ( )
inline

Control the representation of the outline.

This flag enables face wires. By default face wires are off.

Definition at line 205 of file vtkBoxRepresentation.h.

◆ OutlineFaceWiresOff()

void vtkBoxRepresentation::OutlineFaceWiresOff ( )
inline

Control the representation of the outline.

This flag enables face wires. By default face wires are off.

Definition at line 206 of file vtkBoxRepresentation.h.

◆ SetOutlineCursorWires()

void vtkBoxRepresentation::SetOutlineCursorWires ( int  )

Control the representation of the outline.

This flag enables the cursor lines running between the handles. By default cursor wires are on.

◆ GetOutlineCursorWires()

virtual int vtkBoxRepresentation::GetOutlineCursorWires ( )
virtual

Control the representation of the outline.

This flag enables the cursor lines running between the handles. By default cursor wires are on.

◆ OutlineCursorWiresOn()

void vtkBoxRepresentation::OutlineCursorWiresOn ( )
inline

Control the representation of the outline.

This flag enables the cursor lines running between the handles. By default cursor wires are on.

Definition at line 217 of file vtkBoxRepresentation.h.

◆ OutlineCursorWiresOff()

void vtkBoxRepresentation::OutlineCursorWiresOff ( )
inline

Control the representation of the outline.

This flag enables the cursor lines running between the handles. By default cursor wires are on.

Definition at line 218 of file vtkBoxRepresentation.h.

◆ HandlesOn()

virtual void vtkBoxRepresentation::HandlesOn ( )
virtual

Switches handles (the spheres) on or off by manipulating the underlying actor visibility.

◆ HandlesOff()

virtual void vtkBoxRepresentation::HandlesOff ( )
virtual

Switches handles (the spheres) on or off by manipulating the underlying actor visibility.

◆ PlaceWidget()

void vtkBoxRepresentation::PlaceWidget ( double  bounds[6])
override

These are methods that satisfy vtkWidgetRepresentation's API.

◆ BuildRepresentation()

void vtkBoxRepresentation::BuildRepresentation ( )
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Implements vtkWidgetRepresentation.

◆ ComputeInteractionState()

int vtkBoxRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
)
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

◆ StartWidgetInteraction()

void vtkBoxRepresentation::StartWidgetInteraction ( double  e[2])
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

void vtkBoxRepresentation::WidgetInteraction ( double  e[2])
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

◆ GetBounds()

double * vtkBoxRepresentation::GetBounds ( )
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkProp.

◆ StartComplexInteraction()

void vtkBoxRepresentation::StartComplexInteraction ( vtkRenderWindowInteractor iren,
vtkAbstractWidget widget,
unsigned long  event,
void *  calldata 
)
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

◆ ComplexInteraction()

void vtkBoxRepresentation::ComplexInteraction ( vtkRenderWindowInteractor iren,
vtkAbstractWidget widget,
unsigned long  event,
void *  calldata 
)
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

◆ ComputeComplexInteractionState()

int vtkBoxRepresentation::ComputeComplexInteractionState ( vtkRenderWindowInteractor iren,
vtkAbstractWidget widget,
unsigned long  event,
void *  calldata,
int  modify = 0 
)
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

◆ EndComplexInteraction()

void vtkBoxRepresentation::EndComplexInteraction ( vtkRenderWindowInteractor iren,
vtkAbstractWidget widget,
unsigned long  event,
void *  calldata 
)
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

◆ ReleaseGraphicsResources()

void vtkBoxRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkBoxRepresentation::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkBoxRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport )
overridevirtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkBoxRepresentation::HasTranslucentPolygonalGeometry ( )
overridevirtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

◆ SetInteractionState()

void vtkBoxRepresentation::SetInteractionState ( int  state)

The interaction state may be set from a widget (e.g., vtkBoxWidget2) 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.

◆ GetTwoPlaneMode()

virtual bool vtkBoxRepresentation::GetTwoPlaneMode ( )
virtual

In two plane mode only the X planes are shown this is useful for defining thick slabs.

◆ SetTwoPlaneMode()

void vtkBoxRepresentation::SetTwoPlaneMode ( bool  )

In two plane mode only the X planes are shown this is useful for defining thick slabs.

◆ GetSnapToAxes()

virtual bool vtkBoxRepresentation::GetSnapToAxes ( )
virtual

For complex events should we snap orientations to be aligned with the x y z axes.

◆ SetSnapToAxes()

virtual void vtkBoxRepresentation::SetSnapToAxes ( bool  )
virtual

For complex events should we snap orientations to be aligned with the x y z axes.

◆ StepForward()

void vtkBoxRepresentation::StepForward ( )

For complex events should we snap orientations to be aligned with the x y z axes.

◆ StepBackward()

void vtkBoxRepresentation::StepBackward ( )

For complex events should we snap orientations to be aligned with the x y z axes.

◆ RegisterPickers()

void vtkBoxRepresentation::RegisterPickers ( )
overridevirtual

Register internal Pickers in the Picking Manager.

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

Reimplemented from vtkWidgetRepresentation.

◆ GetTranslationAxis()

virtual int vtkBoxRepresentation::GetTranslationAxis ( )
virtual

Gets/Sets the constraint axis for translations.

Returns Axis::NONE if none.

◆ SetTranslationAxis()

virtual void vtkBoxRepresentation::SetTranslationAxis ( int  )
virtual

Gets/Sets the constraint axis for translations.

Returns Axis::NONE if none.

◆ SetXTranslationAxisOn()

void vtkBoxRepresentation::SetXTranslationAxisOn ( )
inline

Toggles constraint translation axis on/off.

Definition at line 331 of file vtkBoxRepresentation.h.

◆ SetYTranslationAxisOn()

void vtkBoxRepresentation::SetYTranslationAxisOn ( )
inline

Toggles constraint translation axis on/off.

Definition at line 332 of file vtkBoxRepresentation.h.

◆ SetZTranslationAxisOn()

void vtkBoxRepresentation::SetZTranslationAxisOn ( )
inline

Toggles constraint translation axis on/off.

Definition at line 333 of file vtkBoxRepresentation.h.

◆ SetTranslationAxisOff()

void vtkBoxRepresentation::SetTranslationAxisOff ( )
inline

Toggles constraint translation axis on/off.

Definition at line 334 of file vtkBoxRepresentation.h.

◆ IsTranslationConstrained()

bool vtkBoxRepresentation::IsTranslationConstrained ( )
inline

Returns true if ConstrainedAxis.

Definition at line 341 of file vtkBoxRepresentation.h.

◆ GetActors()

void vtkBoxRepresentation::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.

◆ GetCorners()

std::vector< double > vtkBoxRepresentation::GetCorners ( )

Get/Set the x,y,z coordinates for the corner points of the 3D box.

This method is an alternative to PlaceWidget(bds) when you already know the exact coordinates for the corners of the box widget.

◆ SetCorners()

void vtkBoxRepresentation::SetCorners ( std::vector< double >  points)

Get/Set the x,y,z coordinates for the corner points of the 3D box.

This method is an alternative to PlaceWidget(bds) when you already know the exact coordinates for the corners of the box widget.

◆ PositionHandles()

virtual void vtkBoxRepresentation::PositionHandles ( )
protectedvirtual

◆ HighlightHandle()

int vtkBoxRepresentation::HighlightHandle ( vtkProp prop)
protected

◆ HighlightFace()

void vtkBoxRepresentation::HighlightFace ( int  cellId)
protected

◆ HighlightOutline()

void vtkBoxRepresentation::HighlightOutline ( int  highlight)
protected

◆ ComputeNormals()

virtual void vtkBoxRepresentation::ComputeNormals ( )
protectedvirtual

◆ SizeHandles()

virtual void vtkBoxRepresentation::SizeHandles ( )
protectedvirtual

◆ CreateDefaultProperties()

virtual void vtkBoxRepresentation::CreateDefaultProperties ( )
protectedvirtual

◆ GenerateOutline()

void vtkBoxRepresentation::GenerateOutline ( )
protected

◆ Translate()

virtual void vtkBoxRepresentation::Translate ( const double *  p1,
const double *  p2 
)
protectedvirtual

◆ Scale()

virtual void vtkBoxRepresentation::Scale ( const double *  p1,
const double *  p2,
int  X,
int  Y 
)
protectedvirtual

◆ Rotate()

virtual void vtkBoxRepresentation::Rotate ( int  X,
int  Y,
const double *  p1,
const double *  p2,
const double *  vpn 
)
protectedvirtual

◆ MovePlusXFace()

void vtkBoxRepresentation::MovePlusXFace ( const double *  p1,
const double *  p2 
)
protected

◆ MoveMinusXFace()

void vtkBoxRepresentation::MoveMinusXFace ( const double *  p1,
const double *  p2 
)
protected

◆ MovePlusYFace()

void vtkBoxRepresentation::MovePlusYFace ( const double *  p1,
const double *  p2 
)
protected

◆ MoveMinusYFace()

void vtkBoxRepresentation::MoveMinusYFace ( const double *  p1,
const double *  p2 
)
protected

◆ MovePlusZFace()

void vtkBoxRepresentation::MovePlusZFace ( const double *  p1,
const double *  p2 
)
protected

◆ MoveMinusZFace()

void vtkBoxRepresentation::MoveMinusZFace ( const double *  p1,
const double *  p2 
)
protected

◆ UpdatePose()

void vtkBoxRepresentation::UpdatePose ( const double *  p1,
const double *  d1,
const double *  p2,
const double *  d2 
)
protected

◆ MoveFace()

void vtkBoxRepresentation::MoveFace ( const double *  p1,
const double *  p2,
const double *  dir,
double *  x1,
double *  x2,
double *  x3,
double *  x4,
double *  x5 
)
protected

◆ GetDirection()

void vtkBoxRepresentation::GetDirection ( const double  Nx[3],
const double  Ny[3],
const double  Nz[3],
double  dir[3] 
)
protected

Member Data Documentation

◆ LastEventPosition

double vtkBoxRepresentation::LastEventPosition[3]
protected

Definition at line 366 of file vtkBoxRepresentation.h.

◆ LastEventOrientation

double vtkBoxRepresentation::LastEventOrientation[4]
protected

Definition at line 367 of file vtkBoxRepresentation.h.

◆ StartEventOrientation

double vtkBoxRepresentation::StartEventOrientation[4]
protected

Definition at line 368 of file vtkBoxRepresentation.h.

◆ SnappedEventOrientations

double vtkBoxRepresentation::SnappedEventOrientations[3][4]
protected

Definition at line 369 of file vtkBoxRepresentation.h.

◆ SnappedOrientation

bool vtkBoxRepresentation::SnappedOrientation[3]
protected

Definition at line 370 of file vtkBoxRepresentation.h.

◆ SnapToAxes

bool vtkBoxRepresentation::SnapToAxes
protected

Definition at line 371 of file vtkBoxRepresentation.h.

◆ TwoPlaneMode

bool vtkBoxRepresentation::TwoPlaneMode
protected

Definition at line 373 of file vtkBoxRepresentation.h.

◆ TranslationAxis

int vtkBoxRepresentation::TranslationAxis
protected

Definition at line 376 of file vtkBoxRepresentation.h.

◆ HexActor

vtkActor* vtkBoxRepresentation::HexActor
protected

Definition at line 379 of file vtkBoxRepresentation.h.

◆ HexMapper

vtkPolyDataMapper* vtkBoxRepresentation::HexMapper
protected

Definition at line 380 of file vtkBoxRepresentation.h.

◆ HexPolyData

vtkPolyData* vtkBoxRepresentation::HexPolyData
protected

Definition at line 381 of file vtkBoxRepresentation.h.

◆ Points

vtkPoints* vtkBoxRepresentation::Points
protected

Definition at line 382 of file vtkBoxRepresentation.h.

◆ N

double vtkBoxRepresentation::N[6][3]
protected

Definition at line 383 of file vtkBoxRepresentation.h.

◆ HexFace

vtkActor* vtkBoxRepresentation::HexFace
protected

Definition at line 386 of file vtkBoxRepresentation.h.

◆ HexFaceMapper

vtkPolyDataMapper* vtkBoxRepresentation::HexFaceMapper
protected

Definition at line 387 of file vtkBoxRepresentation.h.

◆ HexFacePolyData

vtkPolyData* vtkBoxRepresentation::HexFacePolyData
protected

Definition at line 388 of file vtkBoxRepresentation.h.

◆ Handle

vtkActor** vtkBoxRepresentation::Handle
protected

Definition at line 391 of file vtkBoxRepresentation.h.

◆ HandleMapper

vtkPolyDataMapper** vtkBoxRepresentation::HandleMapper
protected

Definition at line 392 of file vtkBoxRepresentation.h.

◆ HandleGeometry

vtkSphereSource** vtkBoxRepresentation::HandleGeometry
protected

Definition at line 393 of file vtkBoxRepresentation.h.

◆ HexOutline

vtkActor* vtkBoxRepresentation::HexOutline
protected

Definition at line 402 of file vtkBoxRepresentation.h.

◆ OutlineMapper

vtkPolyDataMapper* vtkBoxRepresentation::OutlineMapper
protected

Definition at line 403 of file vtkBoxRepresentation.h.

◆ OutlinePolyData

vtkPolyData* vtkBoxRepresentation::OutlinePolyData
protected

Definition at line 404 of file vtkBoxRepresentation.h.

◆ HandlePicker

vtkCellPicker* vtkBoxRepresentation::HandlePicker
protected

Definition at line 407 of file vtkBoxRepresentation.h.

◆ HexPicker

vtkCellPicker* vtkBoxRepresentation::HexPicker
protected

Definition at line 408 of file vtkBoxRepresentation.h.

◆ CurrentHandle

vtkActor* vtkBoxRepresentation::CurrentHandle
protected

Definition at line 409 of file vtkBoxRepresentation.h.

◆ CurrentHexFace

int vtkBoxRepresentation::CurrentHexFace
protected

Definition at line 410 of file vtkBoxRepresentation.h.

◆ LastPicker

vtkCellPicker* vtkBoxRepresentation::LastPicker
protected

Definition at line 411 of file vtkBoxRepresentation.h.

◆ Transform

vtkTransform* vtkBoxRepresentation::Transform
protected

Definition at line 414 of file vtkBoxRepresentation.h.

◆ BoundingBox

vtkBox* vtkBoxRepresentation::BoundingBox
protected

Definition at line 417 of file vtkBoxRepresentation.h.

◆ HandleProperty

vtkProperty* vtkBoxRepresentation::HandleProperty
protected

Definition at line 421 of file vtkBoxRepresentation.h.

◆ SelectedHandleProperty

vtkProperty* vtkBoxRepresentation::SelectedHandleProperty
protected

Definition at line 422 of file vtkBoxRepresentation.h.

◆ FaceProperty

vtkProperty* vtkBoxRepresentation::FaceProperty
protected

Definition at line 423 of file vtkBoxRepresentation.h.

◆ SelectedFaceProperty

vtkProperty* vtkBoxRepresentation::SelectedFaceProperty
protected

Definition at line 424 of file vtkBoxRepresentation.h.

◆ OutlineProperty

vtkProperty* vtkBoxRepresentation::OutlineProperty
protected

Definition at line 425 of file vtkBoxRepresentation.h.

◆ SelectedOutlineProperty

vtkProperty* vtkBoxRepresentation::SelectedOutlineProperty
protected

Definition at line 426 of file vtkBoxRepresentation.h.

◆ InsideOut

vtkTypeBool vtkBoxRepresentation::InsideOut
protected

Definition at line 430 of file vtkBoxRepresentation.h.

◆ OutlineFaceWires

int vtkBoxRepresentation::OutlineFaceWires
protected

Definition at line 431 of file vtkBoxRepresentation.h.

◆ OutlineCursorWires

int vtkBoxRepresentation::OutlineCursorWires
protected

Definition at line 432 of file vtkBoxRepresentation.h.

◆ PlanePoints

vtkPoints* vtkBoxRepresentation::PlanePoints
protected

Definition at line 448 of file vtkBoxRepresentation.h.

◆ PlaneNormals

vtkDoubleArray* vtkBoxRepresentation::PlaneNormals
protected

Definition at line 449 of file vtkBoxRepresentation.h.

◆ Matrix

vtkMatrix4x4* vtkBoxRepresentation::Matrix
protected

Definition at line 450 of file vtkBoxRepresentation.h.

◆ Planes

vtkPlane* vtkBoxRepresentation::Planes[6]
protected

Definition at line 453 of file vtkBoxRepresentation.h.


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