VTK
9.5.20250701
|
actor for an axes plane in a 3D view. More...
#include <vtkGridAxesActor2D.h>
Public Types | |
typedef vtkProp3D | Superclass |
![]() | |
typedef vtkProp | Superclass |
enum | CoordinateSystems { WORLD = 0 , PHYSICAL = 1 , DEVICE = 2 } |
Specify the coordinate system that this prop is relative to. More... | |
![]() | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkGridAxesActor2D * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | GetActors (vtkPropCollection *) override |
For some exporters and other other operations we must be able to collect all the actors or volumes. | |
void | UpdateGeometry (vtkViewport *viewport, bool doRegularUpdate) |
Updates the billboard geometry without performing any rendering, to assist GetActors(). | |
void | SetCustomTickPositions (int axis, vtkDoubleArray *positions) |
Set custom tick positions for each of the axes. | |
void | ReleaseGraphicsResources (vtkWindow *) override |
Release any graphics resources that are being consumed by this prop. | |
vtkMTimeType | GetMTime () override |
Overridden to include the mtime for the text properties. | |
virtual void | SetGridBounds (double, double, double, double, double, double) |
Set the bounding box defining the grid space. | |
virtual void | SetGridBounds (double[6]) |
Set the bounding box defining the grid space. | |
virtual double * | GetGridBounds () |
Set the bounding box defining the grid space. | |
virtual void | GetGridBounds (double &, double &, double &, double &, double &, double &) |
Set the bounding box defining the grid space. | |
virtual void | GetGridBounds (double[6]) |
Set the bounding box defining the grid space. | |
virtual void | SetFace (int) |
Indicate which face of the specified bounds is this class operating with. | |
virtual int | GetFace () |
Indicate which face of the specified bounds is this class operating with. | |
virtual void | SetLabelMask (unsigned int) |
Set the axes to label. | |
virtual unsigned int | GetLabelMask () |
Set the axes to label. | |
void | SetProperty (vtkProperty *) |
Get/Set the property used to control the appearance of the rendered grid, including edges. | |
vtkProperty * | GetProperty () |
Get/Set the property used to control the appearance of the rendered grid, including edges. | |
void | SetTitleTextProperty (int axis, vtkTextProperty *) |
Get/Set the title text properties for each of the coordinate axes. | |
vtkTextProperty * | GetTitleTextProperty (int axis) |
Get/Set the title text properties for each of the coordinate axes. | |
void | SetLabelTextProperty (int axis, vtkTextProperty *) |
Get/Set the label text properties for each of the coordinate axes. | |
vtkTextProperty * | GetLabelTextProperty (int axis) |
Get/Set the label text properties for each of the coordinate axes. | |
void | SetTitle (int axis, const std::string &title) |
Set titles for each of the axes. | |
const std::string & | GetTitle (int axis) |
Set titles for each of the axes. | |
void | SetNotation (int axis, int notation) |
Get/set the numerical notation, standard, scientific or mixed (0, 1, 2). | |
int | GetNotation (int axis) |
Get/set the numerical notation, standard, scientific or mixed (0, 1, 2). | |
void | SetPrecision (int axis, int val) |
Get/set the numerical precision to use, default is 2. | |
int | GetPrecision (int axis) |
Get/set the numerical precision to use, default is 2. | |
void | SetTickLabelFunction (int axis, std::function< double(double)> func) |
Get/Set the function that will be applied to the tick label of each axis. | |
std::function< double(double)> | GetTickLabelFunction (int axis) |
Get/Set the function that will be applied to the tick label of each axis. | |
void | SetGenerateGrid (bool val) |
Turn off to not generate polydata for the plane's grid. | |
bool | GetGenerateGrid () |
Turn off to not generate polydata for the plane's grid. | |
virtual void | GenerateGridOn () |
Turn off to not generate polydata for the plane's grid. | |
virtual void | GenerateGridOff () |
Turn off to not generate polydata for the plane's grid. | |
void | SetGenerateEdges (bool val) |
Turn off to not generate the polydata for the plane's edges. | |
bool | GetGenerateEdges () |
Turn off to not generate the polydata for the plane's edges. | |
virtual void | GenerateEdgesOn () |
Turn off to not generate the polydata for the plane's edges. | |
virtual void | GenerateEdgesOff () |
Turn off to not generate the polydata for the plane's edges. | |
void | SetGenerateTicks (bool val) |
Turn off to not generate the markers for the tick positions. | |
bool | GetGenerateTicks () |
Turn off to not generate the markers for the tick positions. | |
virtual void | GenerateTicksOn () |
Turn off to not generate the markers for the tick positions. | |
virtual void | GenerateTicksOff () |
Turn off to not generate the markers for the tick positions. | |
double * | GetBounds () override |
Returns the prop bounds. | |
virtual void | SetForceOpaque (bool) |
If true, the actor will always be rendered during the opaque pass. | |
virtual bool | GetForceOpaque () |
If true, the actor will always be rendered during the opaque pass. | |
virtual void | ForceOpaqueOn () |
If true, the actor will always be rendered during the opaque pass. | |
virtual void | ForceOpaqueOff () |
If true, the actor will always be rendered during the opaque pass. | |
int | RenderOpaqueGeometry (vtkViewport *) override |
Standard render methods for different types of geometry. | |
int | RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override |
Standard render methods for different types of geometry. | |
int | RenderOverlay (vtkViewport *viewport) override |
Standard render methods for different types of geometry. | |
vtkTypeBool | HasTranslucentPolygonalGeometry () override |
Standard render methods for different types of geometry. | |
virtual void | SetLabelDisplayOffset (int, int) |
Set/Get the label display offset. | |
void | SetLabelDisplayOffset (int[2]) |
Set/Get the label display offset. | |
virtual int * | GetLabelDisplayOffset () |
Set/Get the label display offset. | |
virtual void | GetLabelDisplayOffset (int &, int &) |
Set/Get the label display offset. | |
virtual void | GetLabelDisplayOffset (int[2]) |
Set/Get the label display offset. | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkProp3D * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | ShallowCopy (vtkProp *prop) override |
Shallow copy of this vtkProp3D. | |
virtual void | SetPosition (double pos[3]) |
virtual double * | GetPosition () |
virtual void | GetPosition (double data[3]) |
void | AddPosition (double deltaPosition[3]) |
void | AddPosition (double deltaX, double deltaY, double deltaZ) |
void | SetScale (double s) |
Method to set the scale isotropically. | |
virtual void | SetPropertiesFromModelToWorldMatrix (vtkMatrix4x4 *modelToWorld) |
Set the position, scale, orientation from a provided model to world matrix. | |
double * | GetCenter () |
Get the center of the bounding box in world coordinates. | |
double * | GetXRange () |
Get the Prop3D's x range in world coordinates. | |
double * | GetYRange () |
Get the Prop3D's y range in world coordinates. | |
double * | GetZRange () |
Get the Prop3D's z range in world coordinates. | |
double | GetLength () |
Get the length of the diagonal of the bounding box. | |
void | RotateX (double) |
Rotate the Prop3D in degrees about the X axis using the right hand rule. | |
void | RotateY (double) |
Rotate the Prop3D in degrees about the Y axis using the right hand rule. | |
void | RotateZ (double) |
Rotate the Prop3D in degrees about the Z axis using the right hand rule. | |
void | RotateWXYZ (double w, double x, double y, double z) |
Rotate the Prop3D in degrees about an arbitrary axis specified by the last three arguments. | |
void | SetOrientation (double x, double y, double z) |
Sets the orientation of the Prop3D. | |
void | SetOrientation (double orientation[3]) |
Sets the orientation of the Prop3D. | |
double * | GetOrientationWXYZ () |
Returns the WXYZ orientation of the Prop3D. | |
void | AddOrientation (double x, double y, double z) |
Add to the current orientation. | |
void | AddOrientation (double orentation[3]) |
Add to the current orientation. | |
void | PokeMatrix (vtkMatrix4x4 *matrix) override |
This method modifies the vtkProp3D so that its transformation state is set to the matrix specified. | |
void | InitPathTraversal () override |
Overload vtkProp's method for setting up assembly paths. | |
vtkMTimeType | GetMTime () override |
Get the vtkProp3D's mtime. | |
vtkMTimeType | GetUserTransformMatrixMTime () |
Get the modified time of the user matrix or user transform. | |
virtual void | SetPosition (double x, double y, double z) |
Set/Get/Add the position of the Prop3D in world coordinates. | |
virtual void | SetOrigin (double x, double y, double z) |
Set/Get the origin of the Prop3D. | |
virtual void | SetOrigin (const double pos[3]) |
Set/Get the origin of the Prop3D. | |
virtual double * | GetOrigin () |
Set/Get the origin of the Prop3D. | |
virtual void | GetOrigin (double data[3]) |
Set/Get the origin of the Prop3D. | |
virtual void | SetScale (double x, double y, double z) |
Set/Get the scale of the actor. | |
virtual void | SetScale (double scale[3]) |
Set/Get the scale of the actor. | |
virtual double * | GetScale () |
Set/Get the scale of the actor. | |
virtual void | GetScale (double data[3]) |
Set/Get the scale of the actor. | |
void | SetUserTransform (vtkLinearTransform *transform) |
In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. | |
virtual vtkLinearTransform * | GetUserTransform () |
In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. | |
void | SetUserMatrix (vtkMatrix4x4 *matrix) |
The UserMatrix can be used in place of UserTransform. | |
vtkMatrix4x4 * | GetUserMatrix () |
The UserMatrix can be used in place of UserTransform. | |
virtual void | GetMatrix (vtkMatrix4x4 *result) |
Return a reference to the Prop3D's 4x4 composite matrix. | |
virtual void | GetMatrix (double result[16]) |
Return a reference to the Prop3D's 4x4 composite matrix. | |
virtual void | GetModelToWorldMatrix (vtkMatrix4x4 *result) |
Return a reference to the Prop3D's Model to World matrix. | |
void | GetBounds (double bounds[6]) |
Return a reference to the Prop3D's composite transform. | |
double * | GetOrientation () |
Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. | |
void | GetOrientation (double orentation[3]) |
Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. | |
virtual void | ComputeMatrix () |
Generate the matrix based on ivars. | |
vtkMatrix4x4 * | GetMatrix () override |
Get a pointer to an internal vtkMatrix4x4. | |
virtual vtkTypeBool | GetIsIdentity () |
Is the matrix for this actor identity. | |
void | SetCoordinateSystemRenderer (vtkRenderer *ren) |
Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE. | |
vtkRenderer * | GetCoordinateSystemRenderer () |
Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE. | |
virtual void | SetCoordinateSystemDevice (int) |
Specify the device to be used when the coordinate system is set to DEVICE. | |
virtual int | GetCoordinateSystemDevice () |
Specify the device to be used when the coordinate system is set to DEVICE. | |
void | SetCoordinateSystemToWorld () |
Specify the coordinate system that this prop is relative to. | |
void | SetCoordinateSystemToPhysical () |
Specify the coordinate system that this prop is relative to. | |
void | SetCoordinateSystemToDevice () |
Specify the coordinate system that this prop is relative to. | |
void | SetCoordinateSystem (CoordinateSystems val) |
Specify the coordinate system that this prop is relative to. | |
virtual CoordinateSystems | GetCoordinateSystem () |
Specify the coordinate system that this prop is relative to. | |
const char * | GetCoordinateSystemAsString () |
Specify the coordinate system that this prop is relative to. | |
![]() | |
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 *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 *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 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 *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 () |
![]() | |
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. | |
![]() | |
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 vtkGridAxesActor2D * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkGridAxesActor2D * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkProp3D * | SafeDownCast (vtkObjectBase *o) |
![]() | |
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 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 vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkGridAxesActor2D () | |
~vtkGridAxesActor2D () override | |
bool | Update (vtkViewport *viewport) |
void | UpdateTextProperties (vtkViewport *viewport) |
void | UpdateLabelPositions (vtkViewport *viewport) |
void | UpdateTextActors (vtkViewport *viewport) |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkProp3D () | |
~vtkProp3D () override | |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkProp () | |
~vtkProp () override | |
![]() | |
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. | |
![]() | |
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 &) |
Friends | |
class | vtkGridAxesActor3D |
class | vtkLabels |
actor for an axes plane in a 3D view.
vtkGridAxesActor2D is a vtkProp3D that renders a single axes plane (or face). Despite the name, it renders a prop in 3D with ability to render lines for the axes bounds along with labels on them.
To use this, one sets the GridBounds
and then the Face
which identifies the face of the cube defined by the GridBounds
along which this prop will render the grid. Parameters available allow additional controls including labeling, grid rendering, edge rendering etc.
Definition at line 44 of file vtkGridAxesActor2D.h.
Definition at line 48 of file vtkGridAxesActor2D.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkProp3D.
|
static |
|
protectedvirtual |
Reimplemented from vtkProp3D.
vtkGridAxesActor2D * vtkGridAxesActor2D::NewInstance | ( | ) | const |
|
overridevirtual |
Methods invoked by print to print information about the object including superclasses.
Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObjectBase.
|
virtual |
Set the bounding box defining the grid space.
This, together with the Face
identify which planar surface this class is interested in. This class is designed to work with a single planar surface.
|
virtual |
Set the bounding box defining the grid space.
This, together with the Face
identify which planar surface this class is interested in. This class is designed to work with a single planar surface.
|
virtual |
Set the bounding box defining the grid space.
This, together with the Face
identify which planar surface this class is interested in. This class is designed to work with a single planar surface.
|
virtual |
Set the bounding box defining the grid space.
This, together with the Face
identify which planar surface this class is interested in. This class is designed to work with a single planar surface.
|
virtual |
Set the bounding box defining the grid space.
This, together with the Face
identify which planar surface this class is interested in. This class is designed to work with a single planar surface.
|
virtual |
Indicate which face of the specified bounds is this class operating with.
Defaults to vtkGridAxesHelper::MIN_YZ.
|
virtual |
Indicate which face of the specified bounds is this class operating with.
Defaults to vtkGridAxesHelper::MIN_YZ.
|
virtual |
Set the axes to label.
The mask can be generated by or-ing values in vtkGridAxesActor2D::LabelMasks to label multiple axes. Any request to label an axes not present on the selected Face
is ignored e.g. if Face
is MIN_YZ
, then LabelMask
set to MIN_X
will have no effect.
Default is 0xff.
|
virtual |
Set the axes to label.
The mask can be generated by or-ing values in vtkGridAxesActor2D::LabelMasks to label multiple axes. Any request to label an axes not present on the selected Face
is ignored e.g. if Face
is MIN_YZ
, then LabelMask
set to MIN_X
will have no effect.
Default is 0xff.
|
overridevirtual |
For some exporters and other other operations we must be able to collect all the actors or volumes.
These methods are used in that process. In case the viewport is not a consumer of this prop: call UpdateGeometry() first for updated viewport-specific billboard geometry.
Reimplemented from vtkProp.
void vtkGridAxesActor2D::UpdateGeometry | ( | vtkViewport * | viewport, |
bool | doRegularUpdate | ||
) |
Updates the billboard geometry without performing any rendering, to assist GetActors().
void vtkGridAxesActor2D::SetProperty | ( | vtkProperty * | ) |
Get/Set the property used to control the appearance of the rendered grid, including edges.
vtkProperty * vtkGridAxesActor2D::GetProperty | ( | ) |
Get/Set the property used to control the appearance of the rendered grid, including edges.
void vtkGridAxesActor2D::SetTitleTextProperty | ( | int | axis, |
vtkTextProperty * | |||
) |
Get/Set the title text properties for each of the coordinate axes.
Which properties will be used depends on the selected Face being rendered.
vtkTextProperty * vtkGridAxesActor2D::GetTitleTextProperty | ( | int | axis | ) |
Get/Set the title text properties for each of the coordinate axes.
Which properties will be used depends on the selected Face being rendered.
void vtkGridAxesActor2D::SetLabelTextProperty | ( | int | axis, |
vtkTextProperty * | |||
) |
Get/Set the label text properties for each of the coordinate axes.
Which properties will be used depends on the selected Face being rendered.
vtkTextProperty * vtkGridAxesActor2D::GetLabelTextProperty | ( | int | axis | ) |
Get/Set the label text properties for each of the coordinate axes.
Which properties will be used depends on the selected Face being rendered.
void vtkGridAxesActor2D::SetTitle | ( | int | axis, |
const std::string & | title | ||
) |
Set titles for each of the axes.
Default is empty.
const std::string & vtkGridAxesActor2D::GetTitle | ( | int | axis | ) |
Set titles for each of the axes.
Default is empty.
void vtkGridAxesActor2D::SetNotation | ( | int | axis, |
int | notation | ||
) |
Get/set the numerical notation, standard, scientific or mixed (0, 1, 2).
Accepted values are vtkAxis::AUTO, vtkAxis::FIXED, vtkAxis::CUSTOM.
Default is vtkAxis::AUTO
int vtkGridAxesActor2D::GetNotation | ( | int | axis | ) |
Get/set the numerical notation, standard, scientific or mixed (0, 1, 2).
Accepted values are vtkAxis::AUTO, vtkAxis::FIXED, vtkAxis::CUSTOM.
Default is vtkAxis::AUTO
void vtkGridAxesActor2D::SetPrecision | ( | int | axis, |
int | val | ||
) |
Get/set the numerical precision to use, default is 2.
int vtkGridAxesActor2D::GetPrecision | ( | int | axis | ) |
Get/set the numerical precision to use, default is 2.
void vtkGridAxesActor2D::SetTickLabelFunction | ( | int | axis, |
std::function< double(double)> | func | ||
) |
std::function< double(double)> vtkGridAxesActor2D::GetTickLabelFunction | ( | int | axis | ) |
void vtkGridAxesActor2D::SetCustomTickPositions | ( | int | axis, |
vtkDoubleArray * | positions | ||
) |
Set custom tick positions for each of the axes.
The positions are deep copied. Set to nullptr to not use custom tick positions for the axis.
Default is nullptr.
|
inline |
Turn off to not generate polydata for the plane's grid.
Default is true.
Definition at line 186 of file vtkGridAxesActor2D.h.
|
inline |
Turn off to not generate polydata for the plane's grid.
Default is true.
Definition at line 187 of file vtkGridAxesActor2D.h.
|
virtual |
Turn off to not generate polydata for the plane's grid.
Default is true.
|
virtual |
Turn off to not generate polydata for the plane's grid.
Default is true.
|
inline |
Turn off to not generate the polydata for the plane's edges.
Default is true.
Definition at line 197 of file vtkGridAxesActor2D.h.
|
inline |
Turn off to not generate the polydata for the plane's edges.
Default is true.
Definition at line 198 of file vtkGridAxesActor2D.h.
|
virtual |
Turn off to not generate the polydata for the plane's edges.
Default is true.
|
virtual |
Turn off to not generate the polydata for the plane's edges.
Default is true.
|
inline |
Turn off to not generate the markers for the tick positions.
Which edges are rendered is defined by the TickMask.
Default is true.
Definition at line 209 of file vtkGridAxesActor2D.h.
|
inline |
Turn off to not generate the markers for the tick positions.
Which edges are rendered is defined by the TickMask.
Default is true.
Definition at line 210 of file vtkGridAxesActor2D.h.
|
virtual |
Turn off to not generate the markers for the tick positions.
Which edges are rendered is defined by the TickMask.
Default is true.
|
virtual |
Turn off to not generate the markers for the tick positions.
Which edges are rendered is defined by the TickMask.
Default is true.
|
inlineoverridevirtual |
|
virtual |
If true, the actor will always be rendered during the opaque pass.
Default is false.
|
virtual |
If true, the actor will always be rendered during the opaque pass.
Default is false.
|
virtual |
If true, the actor will always be rendered during the opaque pass.
Default is false.
|
virtual |
If true, the actor will always be rendered during the opaque pass.
Default is false.
|
overridevirtual |
Standard render methods for different types of geometry.
Reimplemented from vtkProp.
|
overridevirtual |
Standard render methods for different types of geometry.
Reimplemented from vtkProp.
|
overridevirtual |
Standard render methods for different types of geometry.
Reimplemented from vtkProp.
|
overridevirtual |
Standard render methods for different types of geometry.
Reimplemented from vtkProp.
|
overridevirtual |
Release any graphics resources that are being consumed by this prop.
The parameter window could be used to determine which graphic resources to release.
Reimplemented from vtkProp.
|
overridevirtual |
Overridden to include the mtime for the text properties.
Reimplemented from vtkObject.
|
virtual |
Set/Get the label display offset.
This is useful to offset axes labels if they overlap at the corners.
Defaults to [0, 0]
void vtkGridAxesActor2D::SetLabelDisplayOffset | ( | int | [2] | ) |
Set/Get the label display offset.
This is useful to offset axes labels if they overlap at the corners.
Defaults to [0, 0]
|
virtual |
Set/Get the label display offset.
This is useful to offset axes labels if they overlap at the corners.
Defaults to [0, 0]
|
virtual |
Set/Get the label display offset.
This is useful to offset axes labels if they overlap at the corners.
Defaults to [0, 0]
|
virtual |
Set/Get the label display offset.
This is useful to offset axes labels if they overlap at the corners.
Defaults to [0, 0]
|
protected |
|
protected |
|
protected |
|
protected |
|
friend |
Definition at line 285 of file vtkGridAxesActor2D.h.
|
friend |
Definition at line 293 of file vtkGridAxesActor2D.h.