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

extended axis tick positioning More...

#include <vtkAxisExtended.h>

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

Public Types

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. More...
 
vtkAxisExtendedNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkVector3d GenerateExtendedTickLabels (double dmin, double dmax, double m, double scaling)
 This method implements the algorithm given in the paper The method return the minimum tick position, maximum tick position and the tick spacing. More...
 
virtual int GetFontSize ()
 Set/Get methods for variables. More...
 
virtual void SetFontSize (int)
 
virtual int GetDesiredFontSize ()
 
virtual void SetDesiredFontSize (int)
 
virtual int GetPrecision ()
 
virtual void SetPrecision (int)
 
virtual int GetLabelFormat ()
 
virtual void SetLabelFormat (int)
 
virtual int GetOrientation ()
 
virtual void SetOrientation (int)
 
virtual bool GetIsAxisVertical ()
 
virtual void SetIsAxisVertical (bool)
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAxisExtendedSafeDownCast (vtkObjectBase *o)
 
static vtkAxisExtendedNew ()
 
static double Simplicity (int qIndex, int qLength, int j, double lmin, double lmax, double lstep)
 This method return a value to make step sizes corresponding to low q and j values more preferable. More...
 
static double SimplicityMax (int qIndex, int qLength, int j)
 This method returns the maximum possible value of simplicity value given q and j. More...
 
static double Coverage (double dmin, double dmax, double lmin, double lmax)
 This method makes the data range approximately same as the labeling range more preferable. More...
 
static double CoverageMax (double dmin, double dmax, double span)
 This gives the maximum possible value of coverage given the step size. More...
 
static double Density (int k, double m, double dmin, double dmax, double lmin, double lmax)
 This method return a value to make the density of the labels close to the user given value. More...
 
static double DensityMax (int k, double m)
 Derives the maximum values for density given k (number of ticks) and m (user given) More...
 
static double FormatLegibilityScore (double n, int format)
 This methods return the legibility score of different formats. More...
 
static int FormatStringLength (int format, double n, int precision)
 This method returns the string length of different format notations. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAxisExtended ()
 
 ~vtkAxisExtended () override
 
double Legibility (double lmin, double lmax, double lstep, double scaling, vtkVector< int, 3 > &parameters)
 This method implements an exhaustive search of the legibilty parameters. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- 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 Orientation
 
int FontSize
 
int DesiredFontSize
 
int Precision
 
int LabelFormat
 
bool LabelLegibilityChanged
 
bool IsAxisVertical
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

extended axis tick positioning

This implements the optimization based tick position calculating algorithm in the paper "An Extension of Wilkinson's Algorithm for Positioning Tick Labels on Axes" by Junstin Talbot, Sharon Lin and Pat Hanrahan

See also
vtkAxis

Definition at line 35 of file vtkAxisExtended.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkAxisExtended.h.

Constructor & Destructor Documentation

◆ vtkAxisExtended()

vtkAxisExtended::vtkAxisExtended ( )
protected

◆ ~vtkAxisExtended()

vtkAxisExtended::~vtkAxisExtended ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAxisExtended::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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAxisExtended::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAxisExtended* vtkAxisExtended::NewInstance ( ) const

◆ New()

static vtkAxisExtended* vtkAxisExtended::New ( )
static

◆ PrintSelf()

void vtkAxisExtended::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

◆ Simplicity()

static double vtkAxisExtended::Simplicity ( int  qIndex,
int  qLength,
int  j,
double  lmin,
double  lmax,
double  lstep 
)
static

This method return a value to make step sizes corresponding to low q and j values more preferable.

◆ SimplicityMax()

static double vtkAxisExtended::SimplicityMax ( int  qIndex,
int  qLength,
int  j 
)
static

This method returns the maximum possible value of simplicity value given q and j.

◆ Coverage()

static double vtkAxisExtended::Coverage ( double  dmin,
double  dmax,
double  lmin,
double  lmax 
)
static

This method makes the data range approximately same as the labeling range more preferable.

◆ CoverageMax()

static double vtkAxisExtended::CoverageMax ( double  dmin,
double  dmax,
double  span 
)
static

This gives the maximum possible value of coverage given the step size.

◆ Density()

static double vtkAxisExtended::Density ( int  k,
double  m,
double  dmin,
double  dmax,
double  lmin,
double  lmax 
)
static

This method return a value to make the density of the labels close to the user given value.

◆ DensityMax()

static double vtkAxisExtended::DensityMax ( int  k,
double  m 
)
static

Derives the maximum values for density given k (number of ticks) and m (user given)

◆ FormatLegibilityScore()

static double vtkAxisExtended::FormatLegibilityScore ( double  n,
int  format 
)
static

This methods return the legibility score of different formats.

◆ FormatStringLength()

static int vtkAxisExtended::FormatStringLength ( int  format,
double  n,
int  precision 
)
static

This method returns the string length of different format notations.

◆ GenerateExtendedTickLabels()

vtkVector3d vtkAxisExtended::GenerateExtendedTickLabels ( double  dmin,
double  dmax,
double  m,
double  scaling 
)

This method implements the algorithm given in the paper The method return the minimum tick position, maximum tick position and the tick spacing.

◆ GetFontSize()

virtual int vtkAxisExtended::GetFontSize ( )
virtual

Set/Get methods for variables.

◆ SetFontSize()

virtual void vtkAxisExtended::SetFontSize ( int  )
virtual

◆ GetDesiredFontSize()

virtual int vtkAxisExtended::GetDesiredFontSize ( )
virtual

◆ SetDesiredFontSize()

virtual void vtkAxisExtended::SetDesiredFontSize ( int  )
virtual

◆ GetPrecision()

virtual int vtkAxisExtended::GetPrecision ( )
virtual

◆ SetPrecision()

virtual void vtkAxisExtended::SetPrecision ( int  )
virtual

◆ GetLabelFormat()

virtual int vtkAxisExtended::GetLabelFormat ( )
virtual

◆ SetLabelFormat()

virtual void vtkAxisExtended::SetLabelFormat ( int  )
virtual

◆ GetOrientation()

virtual int vtkAxisExtended::GetOrientation ( )
virtual

◆ SetOrientation()

virtual void vtkAxisExtended::SetOrientation ( int  )
virtual

◆ GetIsAxisVertical()

virtual bool vtkAxisExtended::GetIsAxisVertical ( )
virtual

◆ SetIsAxisVertical()

virtual void vtkAxisExtended::SetIsAxisVertical ( bool  )
virtual

◆ Legibility()

double vtkAxisExtended::Legibility ( double  lmin,
double  lmax,
double  lstep,
double  scaling,
vtkVector< int, 3 > &  parameters 
)
protected

This method implements an exhaustive search of the legibilty parameters.

Member Data Documentation

◆ Orientation

int vtkAxisExtended::Orientation
protected

Definition at line 129 of file vtkAxisExtended.h.

◆ FontSize

int vtkAxisExtended::FontSize
protected

Definition at line 130 of file vtkAxisExtended.h.

◆ DesiredFontSize

int vtkAxisExtended::DesiredFontSize
protected

Definition at line 131 of file vtkAxisExtended.h.

◆ Precision

int vtkAxisExtended::Precision
protected

Definition at line 132 of file vtkAxisExtended.h.

◆ LabelFormat

int vtkAxisExtended::LabelFormat
protected

Definition at line 133 of file vtkAxisExtended.h.

◆ LabelLegibilityChanged

bool vtkAxisExtended::LabelLegibilityChanged
protected

Definition at line 134 of file vtkAxisExtended.h.

◆ IsAxisVertical

bool vtkAxisExtended::IsAxisVertical
protected

Definition at line 135 of file vtkAxisExtended.h.


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