VTK
9.4.20241202
|
abstract class defines the representation for a vtkButtonWidget More...
#include <vtkButtonRepresentation.h>
Public Types | |
enum | InteractionStateType { Outside = 0 , Inside } |
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 | ShallowCopy (vtkProp *prop) override |
Satisfy some of vtkProp's API. | |
virtual void | SetNumberOfStates (int) |
Retrieve the current button state. | |
virtual int | GetState () |
Retrieve the current button state. | |
virtual void | SetState (int state) |
Manipulate the state. | |
virtual void | NextState () |
Manipulate the state. | |
virtual void | PreviousState () |
Manipulate the state. | |
Public Member Functions inherited from vtkWidgetRepresentation | |
virtual void | PlaceWidget (double vtkNotUsed(bounds)[6]) |
The following is a suggested API for widget representations. | |
virtual void | StartWidgetInteraction (double eventPos[2]) |
virtual void | WidgetInteraction (double newEventPos[2]) |
virtual void | EndWidgetInteraction (double newEventPos[2]) |
virtual int | ComputeInteractionState (int X, int Y, int modify=0) |
virtual int | GetInteractionState () |
virtual void | Highlight (int vtkNotUsed(highlightOn)) |
double * | GetBounds () override |
Methods to make this class behave as a vtkProp. | |
void | ShallowCopy (vtkProp *prop) override |
Shallow copy of this vtkProp. | |
void | GetActors (vtkPropCollection *) override |
For some exporters and other other operations we must be able to collect all the actors or volumes. | |
void | GetActors2D (vtkPropCollection *) override |
void | GetVolumes (vtkPropCollection *) override |
void | ReleaseGraphicsResources (vtkWindow *) override |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. | |
int | RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override |
int | RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override |
int | RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override |
int | RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override |
vtkTypeBool | HasTranslucentPolygonalGeometry () override |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. | |
virtual void | RegisterPickers () |
Register internal Pickers in the Picking Manager. | |
virtual void | UnRegisterPickers () |
Unregister internal pickers from the Picking Manager. | |
virtual void | PickingManagedOn () |
Enable/Disable the use of a manager to process the picking. | |
virtual void | PickingManagedOff () |
Enable/Disable the use of a manager to process the picking. | |
void | SetPickingManaged (bool managed) |
Enable/Disable the use of a manager to process the picking. | |
virtual bool | GetPickingManaged () |
Enable/Disable the use of a manager to process the picking. | |
virtual void | SetRenderer (vtkRenderer *ren) |
Subclasses of vtkWidgetRepresentation must implement these methods. | |
virtual vtkRenderer * | GetRenderer () |
Subclasses of vtkWidgetRepresentation must implement these methods. | |
virtual void | BuildRepresentation ()=0 |
Subclasses of vtkWidgetRepresentation must implement these methods. | |
virtual void | StartComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *) |
virtual void | ComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *) |
virtual void | EndComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *) |
virtual int | ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *callData, int modify=0) |
virtual void | SetPlaceFactor (double) |
Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). | |
virtual double | GetPlaceFactor () |
Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). | |
virtual void | SetHandleSize (double) |
Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). | |
virtual double | GetHandleSize () |
Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). | |
virtual vtkTypeBool | GetNeedToRender () |
Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). | |
virtual void | SetNeedToRender (vtkTypeBool) |
Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). | |
virtual void | NeedToRenderOn () |
Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). | |
virtual void | NeedToRenderOff () |
Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). | |
vtkWidgetRepresentation * | NewInstance () const |
Standard methods for instances of this class. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methods for instances of this class. | |
Public Member Functions inherited from vtkProp | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkProp * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | GetActors (vtkPropCollection *) |
For some exporters and other other operations we must be able to collect all the actors or volumes. | |
virtual void | GetActors2D (vtkPropCollection *) |
virtual void | GetVolumes (vtkPropCollection *) |
virtual void | Pick () |
Method fires PickEvent if the prop is picked. | |
virtual vtkMTimeType | GetRedrawMTime () |
Return the mtime of anything that would cause the rendered image to appear differently. | |
virtual double * | GetBounds () |
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). | |
virtual void | ShallowCopy (vtkProp *prop) |
Shallow copy of this vtkProp. | |
virtual void | PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix)) |
These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. | |
virtual vtkMatrix4x4 * | GetMatrix () |
virtual bool | HasKeys (vtkInformation *requiredKeys) |
Tells if the prop has all the required keys. | |
virtual int | RenderOpaqueGeometry (vtkViewport *) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. | |
virtual int | RenderTranslucentPolygonalGeometry (vtkViewport *) |
virtual int | RenderVolumetricGeometry (vtkViewport *) |
virtual int | RenderOverlay (vtkViewport *) |
virtual bool | RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
Render the opaque geometry only if the prop has all the requiredKeys. | |
virtual bool | RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
Render the translucent polygonal geometry only if the prop has all the requiredKeys. | |
virtual bool | RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
Render the volumetric geometry only if the prop has all the requiredKeys. | |
virtual bool | RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys) |
Render in the overlay of the viewport only if the prop has all the requiredKeys. | |
virtual vtkTypeBool | HasTranslucentPolygonalGeometry () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. | |
virtual vtkTypeBool | HasOpaqueGeometry () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. | |
virtual void | ReleaseGraphicsResources (vtkWindow *) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. | |
virtual double | GetEstimatedRenderTime (vtkViewport *) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. | |
virtual double | GetEstimatedRenderTime () |
virtual void | SetEstimatedRenderTime (double t) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. | |
virtual void | RestoreEstimatedRenderTime () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. | |
virtual void | AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp)) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. | |
void | SetRenderTimeMultiplier (double t) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. | |
virtual double | GetRenderTimeMultiplier () |
virtual void | BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. | |
virtual bool | GetSupportsSelection () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. | |
virtual void | ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &) |
allows a prop to update a selections color buffers | |
virtual void | SetVisibility (vtkTypeBool) |
Set/Get visibility of this vtkProp. | |
virtual vtkTypeBool | GetVisibility () |
Set/Get visibility of this vtkProp. | |
virtual void | VisibilityOn () |
Set/Get visibility of this vtkProp. | |
virtual void | VisibilityOff () |
Set/Get visibility of this vtkProp. | |
virtual void | SetPickable (vtkTypeBool) |
Set/Get the pickable instance variable. | |
virtual vtkTypeBool | GetPickable () |
Set/Get the pickable instance variable. | |
virtual void | PickableOn () |
Set/Get the pickable instance variable. | |
virtual void | PickableOff () |
Set/Get the pickable instance variable. | |
virtual void | SetDragable (vtkTypeBool) |
Set/Get the value of the dragable instance variable. | |
virtual vtkTypeBool | GetDragable () |
Set/Get the value of the dragable instance variable. | |
virtual void | DragableOn () |
Set/Get the value of the dragable instance variable. | |
virtual void | DragableOff () |
Set/Get the value of the dragable instance variable. | |
virtual void | SetUseBounds (bool) |
In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). | |
virtual bool | GetUseBounds () |
In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). | |
virtual void | UseBoundsOn () |
In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). | |
virtual void | UseBoundsOff () |
In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). | |
virtual void | InitPathTraversal () |
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). | |
virtual vtkAssemblyPath * | GetNextPath () |
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). | |
virtual int | GetNumberOfPaths () |
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). | |
virtual vtkInformation * | GetPropertyKeys () |
Set/Get property keys. | |
virtual void | SetPropertyKeys (vtkInformation *keys) |
Set/Get property keys. | |
virtual void | SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v)) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. | |
virtual double | GetAllocatedRenderTime () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. | |
virtual int | GetNumberOfConsumers () |
Get the number of consumers. | |
void | AddConsumer (vtkObject *c) |
Add or remove or get or check a consumer,. | |
void | RemoveConsumer (vtkObject *c) |
Add or remove or get or check a consumer,. | |
vtkObject * | GetConsumer (int i) |
Add or remove or get or check a consumer,. | |
int | IsConsumer (vtkObject *c) |
Add or remove or get or check a consumer,. | |
virtual void | SetShaderProperty (vtkShaderProperty *property) |
Set/Get the shader property. | |
virtual vtkShaderProperty * | GetShaderProperty () |
Set/Get the shader property. | |
virtual bool | IsRenderingTranslucentPolygonalGeometry () |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
vtkTypeBool | InvokeEvent (unsigned long event) |
vtkTypeBool | InvokeEvent (const char *event) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. | |
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual std::string | GetObjectDescription () const |
The object description printed in messages and PrintSelf output. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual bool | UsesGarbageCollector () const |
Indicate whether the class uses vtkGarbageCollector or not. | |
Protected Member Functions | |
vtkButtonRepresentation () | |
~vtkButtonRepresentation () override | |
Protected Member Functions inherited from vtkWidgetRepresentation | |
vtkWidgetRepresentation () | |
~vtkWidgetRepresentation () override | |
void | AdjustBounds (double bounds[6], double newBounds[6], double center[3]) |
vtkPickingManager * | GetPickingManager () |
Return the picking manager associated on the context on which the widget representation currently belong. | |
vtkAssemblyPath * | GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker) |
Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path. | |
vtkAssemblyPath * | GetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker) |
bool | NearbyEvent (int X, int Y, double bounds[6]) |
double | SizeHandlesRelativeToViewport (double factor, double pos[3]) |
double | SizeHandlesInPixels (double factor, double pos[3]) |
void | UpdatePropPose (vtkProp3D *prop, const double *pos1, const double *orient1, const double *pos2, const double *orient2) |
Protected Member Functions inherited from vtkProp | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkProp () | |
~vtkProp () override | |
Protected Member Functions inherited from vtkObject | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
int | NumberOfStates |
int | State |
int | HighlightState |
Protected Attributes inherited from vtkWidgetRepresentation | |
vtkWeakPointer< vtkRenderer > | Renderer |
int | InteractionState |
double | StartEventPosition [3] |
double | PlaceFactor |
int | Placed |
double | InitialBounds [6] |
double | InitialLength |
int | ValidPick |
bool | PickingManaged |
double | HandleSize |
vtkTypeBool | NeedToRender |
vtkTimeStamp | BuildTime |
vtkNew< vtkTransform > | TempTransform |
vtkNew< vtkMatrix4x4 > | TempMatrix |
Protected Attributes inherited from vtkProp | |
vtkTypeBool | Visibility |
vtkTypeBool | Pickable |
vtkTypeBool | Dragable |
bool | UseBounds |
double | AllocatedRenderTime |
double | EstimatedRenderTime |
double | SavedEstimatedRenderTime |
double | RenderTimeMultiplier |
int | NumberOfConsumers |
vtkObject ** | Consumers |
vtkAssemblyPaths * | Paths |
vtkInformation * | PropertyKeys |
vtkShaderProperty * | ShaderProperty |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
Protected Attributes inherited from vtkObjectBase | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
enum | HighlightStateType { HighlightNormal , HighlightHovering , HighlightSelecting } |
These methods control the appearance of the button as it is being interacted with. More... | |
void | Highlight (int) override |
These methods control the appearance of the button as it is being interacted with. | |
virtual int | GetHighlightState () |
These methods control the appearance of the button as it is being interacted with. | |
typedef vtkWidgetRepresentation | Superclass |
Standard methods for the class. | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methods for the class. | |
static vtkButtonRepresentation * | SafeDownCast (vtkObjectBase *o) |
Standard methods for the class. | |
virtual vtkTypeBool | IsA (const char *type) |
Standard methods for the class. | |
vtkButtonRepresentation * | NewInstance () const |
Standard methods for the class. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methods for the class. | |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard methods for the class. | |
Additional Inherited Members | |
Static Public Member Functions inherited from vtkWidgetRepresentation | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methods for instances of this class. | |
static vtkWidgetRepresentation * | SafeDownCast (vtkObjectBase *o) |
Standard methods for instances of this class. | |
Static Public Member Functions inherited from vtkProp | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkProp * | SafeDownCast (vtkObjectBase *o) |
static vtkInformationIntegerKey * | GeneralTextureUnit () |
Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. | |
static vtkInformationDoubleVectorKey * | GeneralTextureTransform () |
Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. | |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static vtkTypeBool | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
Static Public Member Functions inherited from vtkObjectBase | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
abstract class defines the representation for a vtkButtonWidget
This abstract class is used to specify how the vtkButtonWidget should interact with representations of the vtkButtonWidget. This class may be subclassed so that alternative representations can be created. The class defines an API, and a default implementation, that the vtkButtonWidget interacts with to render itself in the scene.
The vtkButtonWidget assumes an n-state button so that traversal methods are available for changing, querying and manipulating state. Derived classed determine the actual appearance. The state is represented by an integral value 0<=state<numStates.
To use this representation, always begin by specifying the number of states. Then follow with the necessary information to represent each state (done through a subclass API).
Definition at line 37 of file vtkButtonRepresentation.h.
Standard methods for the class.
Definition at line 45 of file vtkButtonRepresentation.h.
Enumerator | |
---|---|
Outside | |
Inside |
Definition at line 75 of file vtkButtonRepresentation.h.
These methods control the appearance of the button as it is being interacted with.
Subclasses will behave differently depending on their particulars. HighlightHovering is used when the mouse pointer moves over the button. HighlightSelecting is set when the button is selected. Otherwise, the HighlightNormal is used. The Highlight() method will throw a vtkCommand::HighlightEvent.
Enumerator | |
---|---|
HighlightNormal | |
HighlightHovering | |
HighlightSelecting |
Definition at line 90 of file vtkButtonRepresentation.h.
|
protected |
|
overrideprotected |
|
static |
Standard methods for the class.
|
virtual |
Standard methods for the class.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.
|
static |
Standard methods for the class.
|
protectedvirtual |
Standard methods for the class.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.
vtkButtonRepresentation * vtkButtonRepresentation::NewInstance | ( | ) | const |
Standard methods for the class.
|
overridevirtual |
Standard methods for the class.
Reimplemented from vtkObjectBase.
Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.
|
virtual |
Retrieve the current button state.
|
virtual |
Retrieve the current button state.
|
virtual |
Manipulate the state.
Note that the NextState() and PreviousState() methods use modulo traversal. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.
Reimplemented in vtkProp3DButtonRepresentation.
|
virtual |
Manipulate the state.
Note that the NextState() and PreviousState() methods use modulo traversal. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.
|
virtual |
Manipulate the state.
Note that the NextState() and PreviousState() methods use modulo traversal. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.
|
override |
These methods control the appearance of the button as it is being interacted with.
Subclasses will behave differently depending on their particulars. HighlightHovering is used when the mouse pointer moves over the button. HighlightSelecting is set when the button is selected. Otherwise, the HighlightNormal is used. The Highlight() method will throw a vtkCommand::HighlightEvent.
|
virtual |
These methods control the appearance of the button as it is being interacted with.
Subclasses will behave differently depending on their particulars. HighlightHovering is used when the mouse pointer moves over the button. HighlightSelecting is set when the button is selected. Otherwise, the HighlightNormal is used. The Highlight() method will throw a vtkCommand::HighlightEvent.
|
overridevirtual |
Satisfy some of vtkProp's API.
Reimplemented from vtkProp.
Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.
|
protected |
Definition at line 111 of file vtkButtonRepresentation.h.
|
protected |
Definition at line 112 of file vtkButtonRepresentation.h.
|
protected |
Definition at line 113 of file vtkButtonRepresentation.h.