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

takes care of drawing 2D axes More...

#include <vtkAxis.h>

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

Public Types

enum  { TICK_SIMPLE = 0, TICK_WILKINSON_EXTENDED }
 
typedef vtkContextItem Superclass
 
enum  Location {
  LEFT = 0, BOTTOM, RIGHT, TOP,
  PARALLEL
}
 
enum  { STANDARD_NOTATION = 0, SCIENTIFIC_NOTATION, FIXED_NOTATION, PRINTF_NOTATION }
 
enum  { AUTO = 0, FIXED, CUSTOM }
 
- Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem Superclass
 
- Public Types inherited from vtkAbstractContextItem
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkAxisNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetNumberOfTicks (int numberOfTicks)
 
virtual void SetMinimum (double minimum)
 
virtual void SetMaximum (double maximum)
 
virtual void SetUnscaledMinimum (double minimum)
 
virtual void SetUnscaledMaximum (double maximum)
 
virtual void SetMinimumLimit (double lowest)
 
virtual void SetMaximumLimit (double highest)
 
virtual void SetUnscaledMinimumLimit (double lowest)
 
virtual void SetUnscaledMaximumLimit (double highest)
 
virtual void Update ()
 
virtual bool Paint (vtkContext2D *painter)
 
virtual void AutoScale ()
 
virtual void RecalculateTickSpacing ()
 
virtual vtkDoubleArrayGetTickPositions ()
 
virtual vtkFloatArrayGetTickScenePositions ()
 
virtual vtkStringArrayGetTickLabels ()
 
vtkRectf GetBoundingRect (vtkContext2D *painter)
 
vtkStdString GenerateSimpleLabel (double val)
 
virtual void SetPosition (int position)
 
virtual int GetPosition ()
 
void SetPoint1 (const vtkVector2f &pos)
 
void SetPoint1 (float x, float y)
 
virtual floatGetPoint1 ()
 
virtual void GetPoint1 (float &, float &)
 
virtual void GetPoint1 (float[2])
 
vtkVector2f GetPosition1 ()
 
void SetPoint2 (const vtkVector2f &pos)
 
void SetPoint2 (float x, float y)
 
virtual floatGetPoint2 ()
 
virtual void GetPoint2 (float &, float &)
 
virtual void GetPoint2 (float[2])
 
vtkVector2f GetPosition2 ()
 
virtual int GetNumberOfTicks ()
 
virtual vtkTextPropertyGetLabelProperties ()
 
virtual double GetMinimum ()
 
virtual double GetMaximum ()
 
virtual double GetUnscaledMinimum ()
 
virtual double GetUnscaledMaximum ()
 
virtual void SetRange (double minimum, double maximum)
 
virtual void SetRange (double range[2])
 
virtual void SetUnscaledRange (double minimum, double maximum)
 
virtual void SetUnscaledRange (double range[2])
 
virtual void GetRange (double *range)
 
virtual void GetUnscaledRange (double *range)
 
virtual double GetMinimumLimit ()
 
virtual double GetMaximumLimit ()
 
virtual double GetUnscaledMinimumLimit ()
 
virtual double GetUnscaledMaximumLimit ()
 
virtual intGetMargins ()
 
virtual void GetMargins (int &, int &)
 
virtual void GetMargins (int[2])
 
virtual void SetMargins (int, int)
 
void SetMargins (int[2])
 
virtual void SetTitle (const vtkStdString &title)
 
virtual vtkStdString GetTitle ()
 
virtual vtkTextPropertyGetTitleProperties ()
 
virtual bool GetLogScaleActive ()
 
virtual bool GetLogScale ()
 
virtual void SetLogScale (bool logScale)
 
virtual void LogScaleOn ()
 
virtual void LogScaleOff ()
 
virtual void SetGridVisible (bool)
 
virtual bool GetGridVisible ()
 
virtual void SetLabelsVisible (bool)
 
virtual bool GetLabelsVisible ()
 
virtual void SetRangeLabelsVisible (bool)
 
virtual bool GetRangeLabelsVisible ()
 
virtual void SetTicksVisible (bool)
 
virtual bool GetTicksVisible ()
 
virtual void SetAxisVisible (bool)
 
virtual bool GetAxisVisible ()
 
virtual void SetPrecision (int precision)
 
virtual int GetPrecision ()
 
virtual void SetLabelFormat (const std::string &fmt)
 
virtual std::string GetLabelFormat ()
 
virtual void SetRangeLabelFormat (std::string)
 
virtual std::string GetRangeLabelFormat ()
 
virtual void SetNotation (int notation)
 
virtual int GetNotation ()
 
virtual void SetBehavior (int)
 
virtual int GetBehavior ()
 
virtual vtkPenGetPen ()
 
virtual vtkPenGetGridPen ()
 
virtual void SetTickLabelAlgorithm (int)
 
virtual int GetTickLabelAlgorithm ()
 
virtual void SetScalingFactor (double)
 
virtual double GetScalingFactor ()
 
virtual void SetShift (double)
 
virtual double GetShift ()
 
virtual bool SetCustomTickPositions (vtkDoubleArray *positions, vtkStringArray *labels=0)
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
virtual double GetOpacity ()
 
virtual void SetOpacity (double)
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual bool PaintChildren (vtkContext2D *painter)
 
virtual void ReleaseGraphicsResources ()
 
unsigned int AddItem (vtkAbstractContextItem *item)
 
bool RemoveItem (vtkAbstractContextItem *item)
 
bool RemoveItem (unsigned int index)
 
vtkAbstractContextItemGetItem (unsigned int index)
 
unsigned int GetItemIndex (vtkAbstractContextItem *item)
 
unsigned int GetNumberOfItems ()
 
void ClearItems ()
 
unsigned int Raise (unsigned int index)
 
unsigned int Lower (unsigned int index)
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 
virtual void SetScene (vtkContextScene *scene)
 
virtual void SetParent (vtkAbstractContextItem *parent)
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 
virtual unsigned int StackAbove (unsigned int index, unsigned int under)
 
virtual unsigned int StackUnder (unsigned int child, unsigned int above)
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 
vtkContextSceneGetScene ()
 
vtkAbstractContextItemGetParent ()
 
virtual bool GetVisible ()
 
virtual void SetVisible (bool)
 
virtual bool GetInteractive ()
 
virtual void SetInteractive (bool)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkAxisSafeDownCast (vtkObjectBase *o)
 
static vtkAxisNew ()
 
static double NiceNumber (double number, bool roundUp)
 
static double NiceMinMax (double &min, double &max, float pixelRange, float tickPixelSpacing)
 
- Static Public Member Functions inherited from vtkContextItem
static int IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static int IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAxis ()
 
 ~vtkAxis ()
 
void UpdateLogScaleActive (bool updateMinMaxFromUnscaled)
 
void GenerateTickLabels (double min, double max)
 
void GenerateTickLabels ()
 
void GenerateLabelFormat (int notation, double n)
 
vtkStdString GenerateSprintfLabel (double value, const std::string &format)
 
double CalculateNiceMinMax (double &min, double &max)
 
void GenerateLogSpacedLinearTicks (int order, double min, double max)
 
double LogScaleTickMark (double number, bool roundUp, bool &niceValue, int &order)
 
void GenerateLogScaleTickMarks (int order, double min=1.0, double max=9.0, bool detailLabels=true)
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem ()
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int Position
 
floatPoint1
 
floatPoint2
 
vtkVector2f Position1
 
vtkVector2f Position2
 
double TickInterval
 
int NumberOfTicks
 
vtkTextPropertyLabelProperties
 
double Minimum
 
double Maximum
 
double MinimumLimit
 
double MaximumLimit
 
double UnscaledMinimum
 
double UnscaledMaximum
 
double UnscaledMinimumLimit
 
double UnscaledMaximumLimit
 
double NonLogUnscaledMinLimit
 
double NonLogUnscaledMaxLimit
 
int Margins [2]
 
vtkStdString Title
 
vtkTextPropertyTitleProperties
 
bool LogScale
 
bool LogScaleActive
 
bool GridVisible
 
bool LabelsVisible
 
bool RangeLabelsVisible
 
bool TicksVisible
 
bool AxisVisible
 
int Precision
 
int Notation
 
std::string LabelFormat
 
std::string RangeLabelFormat
 
int Behavior
 
float MaxLabel [2]
 
bool TitleAppended
 
bool CustomTickLabels
 
vtkPenPen
 
vtkPenGridPen
 
vtkSmartPointer< vtkDoubleArrayTickPositions
 
vtkSmartPointer< vtkFloatArrayTickScenePositions
 
vtkSmartPointer< vtkStringArrayTickLabels
 
bool UsingNiceMinMax
 
bool TickMarksDirty
 
bool Resized
 
int TickLabelAlgorithm
 
vtkTimeStamp BuildTime
 
double ScalingFactor
 
double Shift
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 
vtkAbstractContextItemParent
 
vtkContextScenePrivateChildren
 
bool Visible
 
bool Interactive
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

takes care of drawing 2D axes

The vtkAxis is drawn in screen coordinates. It is usually one of the last elements of a chart to be drawn. It renders the axis label, tick marks and tick labels. The tick marks and labels span the range of values between Minimum and Maximum. The Minimum and Maximum values are not allowed to extend beyond the MinimumLimit and MaximumLimit values, respectively.

Note that many other chart elements (e.g., vtkPlotPoints) refer to vtkAxis instances to determine how to scale raw data for presentation. In particular, care must be taken with logarithmic scaling. The axis Minimum, Maximum, and Limit values are stored both unscaled and scaled (with log(x) applied when GetLogScaleActive() returns true). User interfaces will most likely present the unscaled values as they represent the values provided by the user. Other chart elements may need the scaled values in order to draw in the same coordinate system.

Just because LogScale is set to true does not guarantee that the axis will use logarithmic scaling – the Minimum and Maximum values for the axis must both lie to the same side of origin (and not include the origin). Also, this switch from linear- to log-scaling may occur during a rendering pass if autoscaling is enabled. Because the log and pow functions are not invertible and the axis itself decides when to switch between them without offering any external class managing the axis a chance to save the old values, it saves old Limit values in NonLogUnscaled{Min,Max}Limit so that behavior is consistent when LogScale is changed from false to true and back again.

Tests:
vtkAxis (Tests)

Definition at line 70 of file vtkAxis.h.

Member Typedef Documentation

Definition at line 73 of file vtkAxis.h.

Member Enumeration Documentation

Enumeration of the axis locations in a conventional XY chart. Other layouts are possible.

Enumerator
LEFT 
BOTTOM 
RIGHT 
TOP 
PARALLEL 

Definition at line 79 of file vtkAxis.h.

anonymous enum
Enumerator
TICK_SIMPLE 
TICK_WILKINSON_EXTENDED 

Definition at line 88 of file vtkAxis.h.

anonymous enum

Enumeration of the axis notations available.

Enumerator
STANDARD_NOTATION 
SCIENTIFIC_NOTATION 
FIXED_NOTATION 
PRINTF_NOTATION 

Definition at line 327 of file vtkAxis.h.

anonymous enum

Enumeration of the axis behaviors.

Enumerator
AUTO 
FIXED 
CUSTOM 

Definition at line 359 of file vtkAxis.h.

Constructor & Destructor Documentation

vtkAxis::vtkAxis ( )
protected
vtkAxis::~vtkAxis ( )
protected

Member Function Documentation

static int vtkAxis::IsTypeOf ( const char *  type)
static
virtual int vtkAxis::IsA ( const char *  name)
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 vtkContextItem.

static vtkAxis* vtkAxis::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkAxis::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContextItem.

vtkAxis* vtkAxis::NewInstance ( ) const
virtual void vtkAxis::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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 vtkContextItem.

static vtkAxis* vtkAxis::New ( )
static

Creates a 2D Chart object.

virtual void vtkAxis::SetPosition ( int  position)
virtual

Get/set the position of the axis (LEFT, BOTTOM, RIGHT, TOP, PARALLEL).

virtual int vtkAxis::GetPosition ( )
virtual

Get/set the position of the axis (LEFT, BOTTOM, RIGHT, TOP, PARALLEL).

void vtkAxis::SetPoint1 ( const vtkVector2f pos)

Set point 1 of the axis (in pixels), this is usually the origin.

void vtkAxis::SetPoint1 ( float  x,
float  y 
)

Set point 1 of the axis (in pixels), this is usually the origin.

virtual float* vtkAxis::GetPoint1 ( )
virtual

Get point 1 of the axis (in pixels), this is usually the origin.

virtual void vtkAxis::GetPoint1 ( float ,
float  
)
virtual

Get point 1 of the axis (in pixels), this is usually the origin.

virtual void vtkAxis::GetPoint1 ( float  [2])
virtual

Get point 1 of the axis (in pixels), this is usually the origin.

vtkVector2f vtkAxis::GetPosition1 ( )

Get point 1 of the axis (in pixels), this is usually the origin.

void vtkAxis::SetPoint2 ( const vtkVector2f pos)

Set point 2 of the axis (in pixels), this is usually the terminus.

void vtkAxis::SetPoint2 ( float  x,
float  y 
)

Set point 2 of the axis (in pixels), this is usually the terminus.

virtual float* vtkAxis::GetPoint2 ( )
virtual

Get point 2 of the axis (in pixels), this is usually the terminus.

virtual void vtkAxis::GetPoint2 ( float ,
float  
)
virtual

Get point 2 of the axis (in pixels), this is usually the terminus.

virtual void vtkAxis::GetPoint2 ( float  [2])
virtual

Get point 2 of the axis (in pixels), this is usually the terminus.

vtkVector2f vtkAxis::GetPosition2 ( )

Get point 2 of the axis (in pixels), this is usually the terminus.

virtual void vtkAxis::SetNumberOfTicks ( int  numberOfTicks)
virtual

Set the number of tick marks for this axis. Default is -1, which leads to automatic calculation of nicely spaced tick marks.

virtual int vtkAxis::GetNumberOfTicks ( )
virtual

Get the number of tick marks for this axis.

virtual vtkTextProperty* vtkAxis::GetLabelProperties ( )
virtual

Get the vtkTextProperty that governs how the axis lables are displayed. Note that the alignment properties are not used.

virtual void vtkAxis::SetMinimum ( double  minimum)
virtual

Set the logical minimum value of the axis, in plot coordinates. If LogScaleActive is true (not just LogScale), then this sets the minimum base-10 exponent.

virtual double vtkAxis::GetMinimum ( )
virtual

Get the logical minimum value of the axis, in plot coordinates. If LogScaleActive is true (not just LogScale), then this returns the minimum base-10 exponent.

virtual void vtkAxis::SetMaximum ( double  maximum)
virtual

Set the logical maximum value of the axis, in plot coordinates. If LogScaleActive is true (not just LogScale), then this sets the maximum base-10 exponent.

virtual double vtkAxis::GetMaximum ( )
virtual

Get the logical maximum value of the axis, in plot coordinates. If LogScaleActive is true (not just LogScale), then this returns the maximum base-10 exponent.

virtual void vtkAxis::SetUnscaledMinimum ( double  minimum)
virtual

Set the logical, unscaled minimum value of the axis, in plot coordinates. Use this instead of SetMinimum() if you wish to provide the actual minimum instead of log10(the minimum) as part of the axis scale.

virtual double vtkAxis::GetUnscaledMinimum ( )
virtual

Get the logical minimum value of the axis, in plot coordinates.

virtual void vtkAxis::SetUnscaledMaximum ( double  maximum)
virtual

Set the logical maximum value of the axis, in plot coordinates.

virtual double vtkAxis::GetUnscaledMaximum ( )
virtual

Get the logical maximum value of the axis, in plot coordinates.

virtual void vtkAxis::SetRange ( double  minimum,
double  maximum 
)
virtual

Set the logical range of the axis, in plot coordinates. The unscaled range will always be in the same coordinate system of the data being plotted, regardless of whether LogScale is true or false. When calling SetRange() and LogScale is true, the range must be specified in logarithmic coordinates. Using SetUnscaledRange(), you may ignore the value of LogScale.

virtual void vtkAxis::SetRange ( double  range[2])
virtual

Set the logical range of the axis, in plot coordinates. The unscaled range will always be in the same coordinate system of the data being plotted, regardless of whether LogScale is true or false. When calling SetRange() and LogScale is true, the range must be specified in logarithmic coordinates. Using SetUnscaledRange(), you may ignore the value of LogScale.

virtual void vtkAxis::SetUnscaledRange ( double  minimum,
double  maximum 
)
virtual

Set the logical range of the axis, in plot coordinates. The unscaled range will always be in the same coordinate system of the data being plotted, regardless of whether LogScale is true or false. When calling SetRange() and LogScale is true, the range must be specified in logarithmic coordinates. Using SetUnscaledRange(), you may ignore the value of LogScale.

virtual void vtkAxis::SetUnscaledRange ( double  range[2])
virtual

Set the logical range of the axis, in plot coordinates. The unscaled range will always be in the same coordinate system of the data being plotted, regardless of whether LogScale is true or false. When calling SetRange() and LogScale is true, the range must be specified in logarithmic coordinates. Using SetUnscaledRange(), you may ignore the value of LogScale.

virtual void vtkAxis::GetRange ( double range)
virtual

Get the logical range of the axis, in plot coordinates. The unscaled range will always be in the same coordinate system of the data being plotted, regardless of whether LogScale is true or false. Calling GetRange() when LogScale is true will return the log10({min, max}).

virtual void vtkAxis::GetUnscaledRange ( double range)
virtual

Get the logical range of the axis, in plot coordinates. The unscaled range will always be in the same coordinate system of the data being plotted, regardless of whether LogScale is true or false. Calling GetRange() when LogScale is true will return the log10({min, max}).

virtual void vtkAxis::SetMinimumLimit ( double  lowest)
virtual

Set the logical lowest possible value for Minimum, in plot coordinates.

virtual double vtkAxis::GetMinimumLimit ( )
virtual

Get the logical lowest possible value for Minimum, in plot coordinates.

virtual void vtkAxis::SetMaximumLimit ( double  highest)
virtual

Set the logical highest possible value for Maximum, in plot coordinates.

virtual double vtkAxis::GetMaximumLimit ( )
virtual

Get the logical highest possible value for Maximum, in plot coordinates.

virtual void vtkAxis::SetUnscaledMinimumLimit ( double  lowest)
virtual

Set the logical lowest possible value for Minimum, in plot coordinates.

virtual double vtkAxis::GetUnscaledMinimumLimit ( )
virtual

Get the logical lowest possible value for Minimum, in plot coordinates.

virtual void vtkAxis::SetUnscaledMaximumLimit ( double  highest)
virtual

Set the logical highest possible value for Maximum, in plot coordinates.

virtual double vtkAxis::GetUnscaledMaximumLimit ( )
virtual

Get the logical highest possible value for Maximum, in plot coordinates.

virtual int* vtkAxis::GetMargins ( )
virtual

Get the margins of the axis, in pixels.

virtual void vtkAxis::GetMargins ( int ,
int  
)
virtual

Get the margins of the axis, in pixels.

virtual void vtkAxis::GetMargins ( int  [2])
virtual

Get the margins of the axis, in pixels.

virtual void vtkAxis::SetMargins ( int  ,
int   
)
virtual

Set the margins of the axis, in pixels.

void vtkAxis::SetMargins ( int  [2])

Set the margins of the axis, in pixels.

virtual void vtkAxis::SetTitle ( const vtkStdString title)
virtual

Get/set the title text of the axis.

virtual vtkStdString vtkAxis::GetTitle ( )
virtual

Get/set the title text of the axis.

virtual vtkTextProperty* vtkAxis::GetTitleProperties ( )
virtual

Get the vtkTextProperty that governs how the axis title is displayed.

virtual bool vtkAxis::GetLogScaleActive ( )
virtual

Get whether the axis is using a log scale. This will always be false when LogScale is false. It is only true when LogScale is true and the UnscaledRange does not cross or include the origin (zero). The limits (MinimumLimit, MaximumLimit, and their unscaled counterparts) do not prevent LogScaleActive from becoming true; they are adjusted if they cross or include the origin and the original limits are preserved for when LogScaleActive becomes false again.

virtual bool vtkAxis::GetLogScale ( )
virtual

Get/set whether the axis should attempt to use a log scale. The default is false.

See also
{LogScaleActive}.
virtual void vtkAxis::SetLogScale ( bool  logScale)
virtual

Get/set whether the axis should attempt to use a log scale. The default is false.

See also
{LogScaleActive}.
virtual void vtkAxis::LogScaleOn ( )
virtual

Get/set whether the axis should attempt to use a log scale. The default is false.

See also
{LogScaleActive}.
virtual void vtkAxis::LogScaleOff ( )
virtual

Get/set whether the axis should attempt to use a log scale. The default is false.

See also
{LogScaleActive}.
virtual void vtkAxis::SetGridVisible ( bool  )
virtual

Get/set whether the axis grid lines should be drawn, default is true.

virtual bool vtkAxis::GetGridVisible ( )
virtual

Get/set whether the axis grid lines should be drawn, default is true.

virtual void vtkAxis::SetLabelsVisible ( bool  )
virtual

Get/set whether the axis labels should be visible.

virtual bool vtkAxis::GetLabelsVisible ( )
virtual

Get/set whether the axis labels should be visible.

virtual void vtkAxis::SetRangeLabelsVisible ( bool  )
virtual

Get/set whether the labels for the range should be visible.

virtual bool vtkAxis::GetRangeLabelsVisible ( )
virtual

Get/set whether the labels for the range should be visible.

virtual void vtkAxis::SetTicksVisible ( bool  )
virtual

Get/set whether the tick marks should be visible.

virtual bool vtkAxis::GetTicksVisible ( )
virtual

Get/set whether the tick marks should be visible.

virtual void vtkAxis::SetAxisVisible ( bool  )
virtual

Get/set whether the axis line should be visible.

virtual bool vtkAxis::GetAxisVisible ( )
virtual

Get/set whether the axis line should be visible.

virtual void vtkAxis::SetPrecision ( int  precision)
virtual

Get/set the numerical precision to use, default is 2. This is ignored when Notation is STANDARD_NOTATION or PRINTF_NOTATION.

virtual int vtkAxis::GetPrecision ( )
virtual

Get/set the numerical precision to use, default is 2. This is ignored when Notation is STANDARD_NOTATION or PRINTF_NOTATION.

virtual void vtkAxis::SetLabelFormat ( const std::string &  fmt)
virtual

Get/Set the printf-style format string used when TickLabelAlgorithm is TICK_SIMPLE and Notation is PRINTF_NOTATION. The default is "%g".

virtual std::string vtkAxis::GetLabelFormat ( )
virtual

Get/Set the printf-style format string used when TickLabelAlgorithm is TICK_SIMPLE and Notation is PRINTF_NOTATION. The default is "%g".

virtual void vtkAxis::SetRangeLabelFormat ( std::string  )
virtual

Get/Set the printf-style format string used for range labels. This format is always used regardless of TickLabelAlgorithm and Notation. Default is "%g".

virtual std::string vtkAxis::GetRangeLabelFormat ( )
virtual

Get/Set the printf-style format string used for range labels. This format is always used regardless of TickLabelAlgorithm and Notation. Default is "%g".

virtual void vtkAxis::SetNotation ( int  notation)
virtual

Get/set the numerical notation, standard, scientific, fixed, or a printf-style format string.

See also
SetPrecision SetLabelFormat
virtual int vtkAxis::GetNotation ( )
virtual

Get/set the numerical notation, standard, scientific, fixed, or a printf-style format string.

See also
SetPrecision SetLabelFormat
virtual void vtkAxis::SetBehavior ( int  )
virtual

Get/set the behavior of the axis (auto or fixed). The default is 0 (auto).

virtual int vtkAxis::GetBehavior ( )
virtual

Get/set the behavior of the axis (auto or fixed). The default is 0 (auto).

virtual vtkPen* vtkAxis::GetPen ( )
virtual

Get a pointer to the vtkPen object that controls the way this axis is drawn.

virtual vtkPen* vtkAxis::GetGridPen ( )
virtual

Get a pointer to the vtkPen object that controls the way this axis is drawn.

virtual void vtkAxis::SetTickLabelAlgorithm ( int  )
virtual

Get/set the tick label algorithm that is used to calculate the min, max and tick spacing. There are currently two algoriths, vtkAxis::TICK_SIMPLE is the default and uses a simple algorithm. The second option is vtkAxis::TICK_WILKINSON which uses an extended Wilkinson algorithm to find the optimal range, spacing and font parameters.

virtual int vtkAxis::GetTickLabelAlgorithm ( )
virtual

Get/set the tick label algorithm that is used to calculate the min, max and tick spacing. There are currently two algoriths, vtkAxis::TICK_SIMPLE is the default and uses a simple algorithm. The second option is vtkAxis::TICK_WILKINSON which uses an extended Wilkinson algorithm to find the optimal range, spacing and font parameters.

virtual void vtkAxis::SetScalingFactor ( double  )
virtual

Get/set the scaling factor used for the axis, this defaults to 1.0 (no scaling), and is used to coordinate scaling with the plots, charts, etc.

virtual double vtkAxis::GetScalingFactor ( )
virtual

Get/set the scaling factor used for the axis, this defaults to 1.0 (no scaling), and is used to coordinate scaling with the plots, charts, etc.

virtual void vtkAxis::SetShift ( double  )
virtual

Get/set the scaling factor used for the axis, this defaults to 1.0 (no scaling), and is used to coordinate scaling with the plots, charts, etc.

virtual double vtkAxis::GetShift ( )
virtual

Get/set the scaling factor used for the axis, this defaults to 1.0 (no scaling), and is used to coordinate scaling with the plots, charts, etc.

virtual void vtkAxis::Update ( )
virtual

Update the geometry of the axis. Takes care of setting up the tick mark locations etc. Should be called by the scene before rendering.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkAxis::Paint ( vtkContext2D painter)
virtual

Paint event for the axis, called whenever the axis needs to be drawn.

Reimplemented from vtkAbstractContextItem.

virtual void vtkAxis::AutoScale ( )
virtual

Use this function to autoscale the axes after setting the minimum and maximum values. This will cause the axes to select the nicest numbers that enclose the minimum and maximum values, and to select an appropriate number of tick marks.

virtual void vtkAxis::RecalculateTickSpacing ( )
virtual

Recalculate the spacing of the tick marks - typically useful to do after scaling the axis.

virtual vtkDoubleArray* vtkAxis::GetTickPositions ( )
virtual

An array with the positions of the tick marks along the axis line. The positions are specified in the plot coordinates of the axis.

virtual vtkFloatArray* vtkAxis::GetTickScenePositions ( )
virtual

An array with the positions of the tick marks along the axis line. The positions are specified in scene coordinates.

virtual vtkStringArray* vtkAxis::GetTickLabels ( )
virtual

A string array containing the tick labels for the axis.

virtual bool vtkAxis::SetCustomTickPositions ( vtkDoubleArray positions,
vtkStringArray labels = 0 
)
virtual

Set the tick positions, and optionally custom tick labels. If the labels and positions are null then automatic tick labels will be assigned. If only positions are supplied then appropriate labels will be generated according to the axis settings. If positions and labels are supplied they must be of the same length. Returns true on success, false on failure.

vtkRectf vtkAxis::GetBoundingRect ( vtkContext2D painter)

Request the space the axes require to be drawn. This is returned as a vtkRectf, with the corner being the offset from Point1, and the width/ height being the total width/height required by the axis. In order to ensure the numbers are correct, Update() should be called on the axis.

static double vtkAxis::NiceNumber ( double  number,
bool  roundUp 
)
static

Return a "nice number", often defined as 1, 2 or 5. If roundUp is true then the nice number will be rounded up, false it is rounded down. The supplied number should be between 0.0 and 9.9.

static double vtkAxis::NiceMinMax ( double min,
double max,
float  pixelRange,
float  tickPixelSpacing 
)
static

Static function to calculate "nice" minimum, maximum, and tick spacing values.

vtkStdString vtkAxis::GenerateSimpleLabel ( double  val)

Generate a single label using the current settings when TickLabelAlgorithm is TICK_SIMPLE.

void vtkAxis::UpdateLogScaleActive ( bool  updateMinMaxFromUnscaled)
protected

Update whether log scaling will be used for layout and rendering. Log scaling is only active when LogScaling is true and the closed, unscaled range does not contain the origin. The boolean parameter determines whether the minimum and maximum values are set from their unscaled counterparts.

void vtkAxis::GenerateTickLabels ( double  min,
double  max 
)
protected

Calculate and assign nice labels/logical label positions.

void vtkAxis::GenerateTickLabels ( )
protected

Generate tick labels from the supplied double array of tick positions.

void vtkAxis::GenerateLabelFormat ( int  notation,
double  n 
)
protected
vtkStdString vtkAxis::GenerateSprintfLabel ( double  value,
const std::string &  format 
)
protected

Generate label using a printf-style format string.

double vtkAxis::CalculateNiceMinMax ( double min,
double max 
)
protected

Calculate the next "nicest" numbers above and below the current minimum.

Returns
the "nice" spacing of the numbers.
double vtkAxis::LogScaleTickMark ( double  number,
bool  roundUp,
bool &  niceValue,
int order 
)
protected

Return a tick mark for a logarithmic axis. If roundUp is true then the upper tick mark is returned. Otherwise the lower tick mark is returned. Tick marks will be: ... 0.1 0.2 .. 0.9 1 2 .. 9 10 20 .. 90 100 ... Parameter nicevalue will be set to true if tick mark is in: ... 0.1 0.2 0.5 1 2 5 10 20 50 100 ... Parameter order is set to the detected order of magnitude of the number.

void vtkAxis::GenerateLogSpacedLinearTicks ( int  order,
double  min,
double  max 
)
protected

Generate logarithmically-spaced tick marks with linear-style labels. This is for the case when log scaling is active, but the axis min and max span less than an order of magnitude. In this case, the most significant digit that varies is identified and ticks generated for each value that digit may take on. If that results in only 2 tick marks, the next-most-significant digit is varied. If more than 20 tick marks would result, the stride for the varying digit is increased.

void vtkAxis::GenerateLogScaleTickMarks ( int  order,
double  min = 1.0,
double  max = 9.0,
bool  detailLabels = true 
)
protected

Generate tick marks for logarithmic scale for specific order of magnitude. Mark generation is limited by parameters min and max. Tick marks will be: ... 0.1 0.2 .. 0.9 1 2 .. 9 10 20 .. 90 100 ... Tick labels will be: ... 0.1 0.2 0.5 1 2 5 10 20 50 100 ... If Parameter detaillabels is disabled tick labels will be: ... 0.1 1 10 100 ... If min/max is not in between 1.0 and 9.0 defaults will be used. If min and max do not differ 1 defaults will be used.

Member Data Documentation

int vtkAxis::Position
protected

Definition at line 533 of file vtkAxis.h.

float* vtkAxis::Point1
protected

Definition at line 534 of file vtkAxis.h.

float* vtkAxis::Point2
protected

Definition at line 535 of file vtkAxis.h.

vtkVector2f vtkAxis::Position1
protected

Definition at line 536 of file vtkAxis.h.

vtkVector2f vtkAxis::Position2
protected

Definition at line 536 of file vtkAxis.h.

double vtkAxis::TickInterval
protected

Definition at line 537 of file vtkAxis.h.

int vtkAxis::NumberOfTicks
protected

Definition at line 538 of file vtkAxis.h.

vtkTextProperty* vtkAxis::LabelProperties
protected

Definition at line 539 of file vtkAxis.h.

double vtkAxis::Minimum
protected

Definition at line 540 of file vtkAxis.h.

double vtkAxis::Maximum
protected

Definition at line 541 of file vtkAxis.h.

double vtkAxis::MinimumLimit
protected

Definition at line 542 of file vtkAxis.h.

double vtkAxis::MaximumLimit
protected

Definition at line 543 of file vtkAxis.h.

double vtkAxis::UnscaledMinimum
protected

Definition at line 544 of file vtkAxis.h.

double vtkAxis::UnscaledMaximum
protected

Definition at line 545 of file vtkAxis.h.

double vtkAxis::UnscaledMinimumLimit
protected

Definition at line 546 of file vtkAxis.h.

double vtkAxis::UnscaledMaximumLimit
protected

Definition at line 547 of file vtkAxis.h.

double vtkAxis::NonLogUnscaledMinLimit
protected

Definition at line 548 of file vtkAxis.h.

double vtkAxis::NonLogUnscaledMaxLimit
protected

Definition at line 549 of file vtkAxis.h.

int vtkAxis::Margins[2]
protected

Definition at line 550 of file vtkAxis.h.

vtkStdString vtkAxis::Title
protected

Definition at line 551 of file vtkAxis.h.

vtkTextProperty* vtkAxis::TitleProperties
protected

Definition at line 552 of file vtkAxis.h.

bool vtkAxis::LogScale
protected

Definition at line 553 of file vtkAxis.h.

bool vtkAxis::LogScaleActive
protected

Definition at line 554 of file vtkAxis.h.

bool vtkAxis::GridVisible
protected

Definition at line 555 of file vtkAxis.h.

bool vtkAxis::LabelsVisible
protected

Definition at line 556 of file vtkAxis.h.

bool vtkAxis::RangeLabelsVisible
protected

Definition at line 557 of file vtkAxis.h.

bool vtkAxis::TicksVisible
protected

Definition at line 558 of file vtkAxis.h.

bool vtkAxis::AxisVisible
protected

Definition at line 559 of file vtkAxis.h.

int vtkAxis::Precision
protected

Definition at line 560 of file vtkAxis.h.

int vtkAxis::Notation
protected

Definition at line 561 of file vtkAxis.h.

std::string vtkAxis::LabelFormat
protected

Definition at line 562 of file vtkAxis.h.

std::string vtkAxis::RangeLabelFormat
protected

Definition at line 563 of file vtkAxis.h.

int vtkAxis::Behavior
protected

Definition at line 564 of file vtkAxis.h.

float vtkAxis::MaxLabel[2]
protected

Definition at line 565 of file vtkAxis.h.

bool vtkAxis::TitleAppended
protected

Definition at line 566 of file vtkAxis.h.

double vtkAxis::ScalingFactor
protected

Scaling factor used on this axis, this is used to accurately render very small/large numbers accurately by converting the underlying range by the scaling factor.

Definition at line 573 of file vtkAxis.h.

double vtkAxis::Shift
protected

Scaling factor used on this axis, this is used to accurately render very small/large numbers accurately by converting the underlying range by the scaling factor.

Definition at line 574 of file vtkAxis.h.

bool vtkAxis::CustomTickLabels
protected

Are we using custom tick labels, or should the axis generate them?

Definition at line 578 of file vtkAxis.h.

vtkPen* vtkAxis::Pen
protected

This object stores the vtkPen that controls how the axis is drawn.

Definition at line 581 of file vtkAxis.h.

vtkPen* vtkAxis::GridPen
protected

This object stores the vtkPen that controls how the grid lines are drawn.

Definition at line 585 of file vtkAxis.h.

vtkSmartPointer<vtkDoubleArray> vtkAxis::TickPositions
protected

Position of tick marks in screen coordinates

Definition at line 588 of file vtkAxis.h.

vtkSmartPointer<vtkFloatArray> vtkAxis::TickScenePositions
protected

Position of tick marks in screen coordinates

Definition at line 591 of file vtkAxis.h.

vtkSmartPointer<vtkStringArray> vtkAxis::TickLabels
protected

The labels for the tick marks

Definition at line 594 of file vtkAxis.h.

bool vtkAxis::UsingNiceMinMax
protected

Hint as to whether a nice min/max was set, otherwise labels may not be present at the top/bottom of the axis.

Definition at line 598 of file vtkAxis.h.

bool vtkAxis::TickMarksDirty
protected

Mark the tick labels as dirty when the min/max value is changed.

Definition at line 601 of file vtkAxis.h.

bool vtkAxis::Resized
protected

Flag to indicate that the axis has been resized.

Definition at line 604 of file vtkAxis.h.

int vtkAxis::TickLabelAlgorithm
protected

The algorithm being used to tick label placement.

Definition at line 607 of file vtkAxis.h.

vtkTimeStamp vtkAxis::BuildTime
protected

The point cache is marked dirty until it has been initialized.

Definition at line 610 of file vtkAxis.h.


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