vtkQtChartAxisCornerDomain Class Reference

#include <vtkQtChartAxisCornerDomain.h>

List of all members.


Detailed Description

The vtkQtChartAxisCornerDomain class is used to merge similar domains for a pair of axes.

Definition at line 39 of file vtkQtChartAxisCornerDomain.h.


Public Member Functions

 vtkQtChartAxisCornerDomain ()
 vtkQtChartAxisCornerDomain (const vtkQtChartAxisCornerDomain &other)
 ~vtkQtChartAxisCornerDomain ()
int getNumberOfDomains () const
 Gets the number of domains.
const vtkQtChartSeriesDomaingetDomain (int index) const
 Gets the domain for the given index.
vtkQtChartSeriesDomaingetDomain (int index)
 Gets the domain for the given index.
const vtkQtChartSeriesDomaingetDomain (const vtkQtChartAxisDomainPriority &xPriority, const vtkQtChartAxisDomainPriority &yPriority) const
 Gets the best domain match for the given priorities.
const vtkQtChartSeriesDomaingetDomain (vtkQtChartAxis::AxisDomain xDomain, const vtkQtChartAxisDomainPriority &yPriority) const
 Gets the best domain match for the given type and priority.
const vtkQtChartSeriesDomaingetDomain (const vtkQtChartAxisDomainPriority &xPriority, vtkQtChartAxis::AxisDomain yDomain) const
 Gets the best domain match for the given type and priority.
const vtkQtChartSeriesDomaingetDomain (vtkQtChartAxis::AxisDomain xDomain, vtkQtChartAxis::AxisDomain yDomain, int *index=0) const
 Gets the best domain match for the given types.
bool mergeDomain (const vtkQtChartSeriesDomain &domain, int *index=0)
 Merges the given domain with the current domains.
void removeDomain (int index)
 Removes the domain at the specified index.
void clear ()
 Removes all the domains.
void setHorizontalPreferences (bool padRange, bool expandToZero, bool addSpace)
 Sets the preferences for the horizontal axis.
void setVerticalPreferences (bool padRange, bool expandToZero, bool addSpace)
 Sets the preferences for the vertical axis.
vtkQtChartAxisCornerDomainoperator= (const vtkQtChartAxisCornerDomain &other)

Constructor & Destructor Documentation

vtkQtChartAxisCornerDomain::vtkQtChartAxisCornerDomain (  ) 

vtkQtChartAxisCornerDomain::vtkQtChartAxisCornerDomain ( const vtkQtChartAxisCornerDomain other  ) 

vtkQtChartAxisCornerDomain::~vtkQtChartAxisCornerDomain (  ) 


Member Function Documentation

int vtkQtChartAxisCornerDomain::getNumberOfDomains (  )  const

Gets the number of domains.

Compatible domains are merged together. The number of domains is the number of different types of domains added to the corner.

Returns:
The number of domains.

const vtkQtChartSeriesDomain* vtkQtChartAxisCornerDomain::getDomain ( int  index  )  const

Gets the domain for the given index.

Parameters:
index The domain index.
Returns:
A pointer to the domain at the given index.

vtkQtChartSeriesDomain* vtkQtChartAxisCornerDomain::getDomain ( int  index  ) 

Gets the domain for the given index.

Parameters:
index The domain index.
Returns:
A pointer to the domain at the given index.

const vtkQtChartSeriesDomain* vtkQtChartAxisCornerDomain::getDomain ( const vtkQtChartAxisDomainPriority xPriority,
const vtkQtChartAxisDomainPriority yPriority 
) const

Gets the best domain match for the given priorities.

Parameters:
xPriority The x-axis priority.
yPriority The y-axis priority.
Returns:
A pointer to the domain for the given priorities.

const vtkQtChartSeriesDomain* vtkQtChartAxisCornerDomain::getDomain ( vtkQtChartAxis::AxisDomain  xDomain,
const vtkQtChartAxisDomainPriority yPriority 
) const

Gets the best domain match for the given type and priority.

Parameters:
xDomain The domain type for the x-axis.
yPriority The y-axis priority.
Returns:
A pointer to the domain for the given type and priority.

const vtkQtChartSeriesDomain* vtkQtChartAxisCornerDomain::getDomain ( const vtkQtChartAxisDomainPriority xPriority,
vtkQtChartAxis::AxisDomain  yDomain 
) const

Gets the best domain match for the given type and priority.

Parameters:
xPriority The x-axis priority.
yDomain The domain type for the y-axis.
Returns:
A pointer to the domain for the given type and priority.

const vtkQtChartSeriesDomain* vtkQtChartAxisCornerDomain::getDomain ( vtkQtChartAxis::AxisDomain  xDomain,
vtkQtChartAxis::AxisDomain  yDomain,
int *  index = 0 
) const

Gets the best domain match for the given types.

Parameters:
xDomain The domain type for the x-axis.
yDomain The domain type for the y-axis.
index Used to return the index of the returned domain.
Returns:
A pointer to the domain for the given types.

bool vtkQtChartAxisCornerDomain::mergeDomain ( const vtkQtChartSeriesDomain domain,
int *  index = 0 
)

Merges the given domain with the current domains.

If the domain is compatible with one of the current domains, it is merged. Otherwise, the domain is added to the list. The index can be used to get a pointer to the combined or newly created domain.

Parameters:
domain The domain to add.
index Used to return the index where the domain was added.
Returns:
True if the new domain changed the current domains.

void vtkQtChartAxisCornerDomain::removeDomain ( int  index  ) 

Removes the domain at the specified index.

Parameters:
index The index to remove.

void vtkQtChartAxisCornerDomain::clear (  ) 

Removes all the domains.

void vtkQtChartAxisCornerDomain::setHorizontalPreferences ( bool  padRange,
bool  expandToZero,
bool  addSpace 
)

Sets the preferences for the horizontal axis.

Parameters:
padRange True if the range should be padded.
expandToZero True if the range should be expanded to zero.
addSpace True if space should be added to the end labels.

void vtkQtChartAxisCornerDomain::setVerticalPreferences ( bool  padRange,
bool  expandToZero,
bool  addSpace 
)

Sets the preferences for the vertical axis.

Parameters:
padRange True if the range should be padded.
expandToZero True if the range should be expanded to zero.
addSpace True if space should be added to the end labels.

vtkQtChartAxisCornerDomain& vtkQtChartAxisCornerDomain::operator= ( const vtkQtChartAxisCornerDomain other  ) 


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

Generated on Wed Aug 24 11:59:14 2011 for VTK by  doxygen 1.5.6