VTK  9.3.20240328
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkProp3DButtonRepresentation Class Reference

defines a representation for a vtkButtonWidget More...

#include <vtkProp3DButtonRepresentation.h>

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

Public Member Functions

void SetState (int state) override
 Extend the vtkButtonRepresentation::SetState() method. More...
 
void PlaceWidget (double bounds[6]) override
 This method positions (translates and scales the props) into the bounding box specified. More...
 
void RegisterPickers () override
 Register internal Pickers in the Picking Manager. More...
 
void SetButtonProp (int i, vtkProp3D *prop)
 Add the ith texture corresponding to the ith button state. More...
 
vtkProp3DGetButtonProp (int i)
 Add the ith texture corresponding to the ith button state. More...
 
virtual void SetFollowCamera (vtkTypeBool)
 Specify whether the button should always face the camera. More...
 
virtual vtkTypeBool GetFollowCamera ()
 Specify whether the button should always face the camera. More...
 
virtual void FollowCameraOn ()
 Specify whether the button should always face the camera. More...
 
virtual void FollowCameraOff ()
 Specify whether the button should always face the camera. More...
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 Provide the necessary methods to satisfy the vtkWidgetRepresentation API. More...
 
void BuildRepresentation () override
 Provide the necessary methods to satisfy the vtkWidgetRepresentation API. More...
 
void ShallowCopy (vtkProp *prop) override
 Provide the necessary methods to satisfy the rendering API. More...
 
double * GetBounds () override
 Provide the necessary methods to satisfy the rendering API. More...
 
void GetActors (vtkPropCollection *pc) override
 Provide the necessary methods to satisfy the rendering API. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Provide the necessary methods to satisfy the rendering API. More...
 
int RenderOpaqueGeometry (vtkViewport *) override
 Provide the necessary methods to satisfy the rendering API. More...
 
int RenderVolumetricGeometry (vtkViewport *) override
 Provide the necessary methods to satisfy the rendering API. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) override
 Provide the necessary methods to satisfy the rendering API. More...
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Provide the necessary methods to satisfy the rendering API. More...
 
- Public Member Functions inherited from vtkButtonRepresentation
virtual void SetNumberOfStates (int)
 Retrieve the current button state. More...
 
virtual int GetState ()
 Retrieve the current button state. More...
 
virtual void NextState ()
 Manipulate the state. More...
 
virtual void PreviousState ()
 Manipulate the state. More...
 
void Highlight (int) override
 These methods control the appearance of the button as it is being interacted with. More...
 
virtual int GetHighlightState ()
 These methods control the appearance of the button as it is being interacted with. More...
 
vtkButtonRepresentationNewInstance () const
 Standard methods for the class. 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 WidgetInteraction (double newEventPos[2])
 
virtual void EndWidgetInteraction (double newEventPos[2])
 
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 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 void SetRenderer (vtkRenderer *ren)
 Subclasses of vtkWidgetRepresentation must implement these methods. 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 RenderOverlay (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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. 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...
 
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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkProp3DButtonRepresentationNew ()
 Instantiate the class. More...
 
- Static Public Member Functions inherited from vtkButtonRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for the class. More...
 
static vtkButtonRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for the 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 (vtkTypeBool 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 vtkTypeBool 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

 vtkProp3DButtonRepresentation ()
 
 ~vtkProp3DButtonRepresentation () override
 
- Protected Member Functions inherited from vtkButtonRepresentation
 vtkButtonRepresentation ()
 
 ~vtkButtonRepresentation () 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

vtkProp3DCurrentProp
 
vtkProp3DFollowerFollower
 
vtkTypeBool FollowCamera
 
vtkPropArray * PropArray
 
vtkPropPickerPicker
 
- Protected Attributes inherited from vtkButtonRepresentation
int NumberOfStates
 
int State
 
int HighlightState
 
- 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 vtkButtonRepresentation Superclass
 Standard methods for instances of the class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of the class. More...
 
static vtkProp3DButtonRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of the class. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instances of the class. More...
 
vtkProp3DButtonRepresentationNewInstance () const
 Standard methods for instances of the class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of the class. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instances of the class. More...
 

Additional Inherited Members

- Public Types inherited from vtkButtonRepresentation
enum  InteractionStateType { Outside = 0 , Inside }
 
enum  HighlightStateType { HighlightNormal , HighlightHovering , HighlightSelecting }
 These methods control the appearance of the button as it is being interacted with. More...
 
typedef vtkWidgetRepresentation Superclass
 Standard methods for the class. More...
 
- 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. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

defines a representation for a vtkButtonWidget

This class implements one type of vtkButtonRepresentation. Each button state can be represented with a separate instance of vtkProp3D. Thus buttons can be represented with vtkActor, vtkImageActor, volumes (e.g., vtkVolume) and/or any other vtkProp3D. Also, the class invokes events when highlighting occurs (i.e., hovering, selecting) so that appropriate action can be taken to highlight the button (if desired).

To use this representation, always begin by specifying the number of button states. Then provide, for each state, an instance of vtkProp3D.

This widget representation uses the conventional placement method. The button is placed inside the bounding box defined by PlaceWidget by translating and scaling the vtkProp3D to fit (each vtkProp3D is transformed). Therefore, you must define the number of button states and each state (i.e., vtkProp3D) prior to calling vtkPlaceWidget.

See also
vtkButtonWidget vtkButtonRepresentation vtkButtonSource vtkEllipticalButtonSource vtkRectangularButtonSource
Online Examples:

Tests:
vtkProp3DButtonRepresentation (Tests)

Definition at line 62 of file vtkProp3DButtonRepresentation.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of the class.

Definition at line 74 of file vtkProp3DButtonRepresentation.h.

Constructor & Destructor Documentation

◆ vtkProp3DButtonRepresentation()

vtkProp3DButtonRepresentation::vtkProp3DButtonRepresentation ( )
protected

◆ ~vtkProp3DButtonRepresentation()

vtkProp3DButtonRepresentation::~vtkProp3DButtonRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkProp3DButtonRepresentation* vtkProp3DButtonRepresentation::New ( )
static

Instantiate the class.

◆ IsTypeOf()

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

Standard methods for instances of the class.

◆ IsA()

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

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

◆ SafeDownCast()

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

Standard methods for instances of the class.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkProp3DButtonRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

◆ NewInstance()

vtkProp3DButtonRepresentation* vtkProp3DButtonRepresentation::NewInstance ( ) const

Standard methods for instances of the class.

◆ PrintSelf()

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

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

◆ SetButtonProp()

void vtkProp3DButtonRepresentation::SetButtonProp ( int  i,
vtkProp3D prop 
)

Add the ith texture corresponding to the ith button state.

The parameter i should be (0 <= i < NumberOfStates).

◆ GetButtonProp()

vtkProp3D* vtkProp3DButtonRepresentation::GetButtonProp ( int  i)

Add the ith texture corresponding to the ith button state.

The parameter i should be (0 <= i < NumberOfStates).

◆ SetFollowCamera()

virtual void vtkProp3DButtonRepresentation::SetFollowCamera ( vtkTypeBool  )
virtual

Specify whether the button should always face the camera.

If enabled, the button reorients itself towards the camera as the camera moves.

◆ GetFollowCamera()

virtual vtkTypeBool vtkProp3DButtonRepresentation::GetFollowCamera ( )
virtual

Specify whether the button should always face the camera.

If enabled, the button reorients itself towards the camera as the camera moves.

◆ FollowCameraOn()

virtual void vtkProp3DButtonRepresentation::FollowCameraOn ( )
virtual

Specify whether the button should always face the camera.

If enabled, the button reorients itself towards the camera as the camera moves.

◆ FollowCameraOff()

virtual void vtkProp3DButtonRepresentation::FollowCameraOff ( )
virtual

Specify whether the button should always face the camera.

If enabled, the button reorients itself towards the camera as the camera moves.

◆ SetState()

void vtkProp3DButtonRepresentation::SetState ( int  state)
overridevirtual

Extend the vtkButtonRepresentation::SetState() method.

Reimplemented from vtkButtonRepresentation.

◆ ComputeInteractionState()

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

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from vtkWidgetRepresentation.

◆ BuildRepresentation()

void vtkProp3DButtonRepresentation::BuildRepresentation ( )
overridevirtual

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Implements vtkWidgetRepresentation.

◆ PlaceWidget()

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

This method positions (translates and scales the props) into the bounding box specified.

Note all the button props are scaled.

◆ ShallowCopy()

void vtkProp3DButtonRepresentation::ShallowCopy ( vtkProp prop)
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkButtonRepresentation.

◆ GetBounds()

double* vtkProp3DButtonRepresentation::GetBounds ( )
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

◆ GetActors()

void vtkProp3DButtonRepresentation::GetActors ( vtkPropCollection pc)
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkProp3DButtonRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkProp3DButtonRepresentation::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

◆ RenderVolumetricGeometry()

int vtkProp3DButtonRepresentation::RenderVolumetricGeometry ( vtkViewport )
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkProp3DButtonRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport )
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkProp3DButtonRepresentation::HasTranslucentPolygonalGeometry ( )
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

◆ RegisterPickers()

void vtkProp3DButtonRepresentation::RegisterPickers ( )
overridevirtual

Register internal Pickers in the Picking Manager.

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

Reimplemented from vtkWidgetRepresentation.

Member Data Documentation

◆ CurrentProp

vtkProp3D* vtkProp3DButtonRepresentation::CurrentProp
protected

Definition at line 140 of file vtkProp3DButtonRepresentation.h.

◆ Follower

vtkProp3DFollower* vtkProp3DButtonRepresentation::Follower
protected

Definition at line 143 of file vtkProp3DButtonRepresentation.h.

◆ FollowCamera

vtkTypeBool vtkProp3DButtonRepresentation::FollowCamera
protected

Definition at line 144 of file vtkProp3DButtonRepresentation.h.

◆ PropArray

vtkPropArray* vtkProp3DButtonRepresentation::PropArray
protected

Definition at line 148 of file vtkProp3DButtonRepresentation.h.

◆ Picker

vtkPropPicker* vtkProp3DButtonRepresentation::Picker
protected

Definition at line 151 of file vtkProp3DButtonRepresentation.h.


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