vtkQtChartIndexRange Class Reference

#include <vtkQtChartIndexRangeList.h>

Collaboration diagram for vtkQtChartIndexRange:

Collaboration graph
[legend]

List of all members.


Detailed Description

The vtkQtChartIndexRange class is used to build a tree of index ranges.

Definition at line 34 of file vtkQtChartIndexRangeList.h.


Public Member Functions

 vtkQtChartIndexRange ()
 vtkQtChartIndexRange (int first, int second, bool black=true)
 Creates an index range instance.
 vtkQtChartIndexRange (const vtkQtChartIndexRange &other)
 ~vtkQtChartIndexRange ()
vtkQtChartIndexRangeoperator= (const vtkQtChartIndexRange &other)
Index Range Methods
int getFirst () const
 Gets the first index in the range.
void setFirst (int first)
 Sets the first index in the range.
int getSecond () const
 Gets the last index in the range.
void setSecond (int second)
 Sets the last index in the range.
bool contains (int value) const
 Gets whether or not the given value is in the range.
Tree Methods
bool isBlack () const
 Gets whether the node is black or red.
void setBlack (bool black)
 Sets whether the node is black or red.
vtkQtChartIndexRangegetParent () const
 Gets the parent node.
void setParent (vtkQtChartIndexRange *parent)
 Sets the parent node.
vtkQtChartIndexRangegetLeft () const
 Gets the left child node.
void setLeft (vtkQtChartIndexRange *left)
 Sets the left child node.
vtkQtChartIndexRangegetRight () const
 Gets the right child node.
void setRight (vtkQtChartIndexRange *right)
 Sets the right child node.

Constructor & Destructor Documentation

vtkQtChartIndexRange::vtkQtChartIndexRange (  ) 

vtkQtChartIndexRange::vtkQtChartIndexRange ( int  first,
int  second,
bool  black = true 
)

Creates an index range instance.

Parameters:
first The first index in the range.
second The last index in the range.
black True if the node should be black.

vtkQtChartIndexRange::vtkQtChartIndexRange ( const vtkQtChartIndexRange other  ) 

vtkQtChartIndexRange::~vtkQtChartIndexRange (  ) 


Member Function Documentation

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

int vtkQtChartIndexRange::getFirst (  )  const [inline]

Gets the first index in the range.

Returns:
The first index in the range.

Definition at line 56 of file vtkQtChartIndexRangeList.h.

void vtkQtChartIndexRange::setFirst ( int  first  ) 

Sets the first index in the range.

This method also updates the first index range for all the affected parent nodes.

Parameters:
first The first index in the range.

int vtkQtChartIndexRange::getSecond (  )  const [inline]

Gets the last index in the range.

Returns:
The last index in the range.

Definition at line 71 of file vtkQtChartIndexRangeList.h.

void vtkQtChartIndexRange::setSecond ( int  second  ) 

Sets the last index in the range.

This method also updates the last index range for all the affected parent nodes.

Parameters:
second The last index in the range.

bool vtkQtChartIndexRange::contains ( int  value  )  const

Gets whether or not the given value is in the range.

Parameters:
value The value to find.
Returns:
True if the given value is in the range.

bool vtkQtChartIndexRange::isBlack (  )  const [inline]

Gets whether the node is black or red.

Returns:
True if the node is black. False if the node is red.

Definition at line 96 of file vtkQtChartIndexRangeList.h.

void vtkQtChartIndexRange::setBlack ( bool  black  )  [inline]

Sets whether the node is black or red.

Parameters:
black True if the node is black. False if the node is red.

Definition at line 101 of file vtkQtChartIndexRangeList.h.

vtkQtChartIndexRange* vtkQtChartIndexRange::getParent (  )  const [inline]

Gets the parent node.

Returns:
A pointer to the parent node.

Definition at line 107 of file vtkQtChartIndexRangeList.h.

void vtkQtChartIndexRange::setParent ( vtkQtChartIndexRange parent  )  [inline]

Sets the parent node.

Parameters:
parent The new parent node.

Definition at line 112 of file vtkQtChartIndexRangeList.h.

vtkQtChartIndexRange* vtkQtChartIndexRange::getLeft (  )  const [inline]

Gets the left child node.

Returns:
A pointer to the left child node.

Definition at line 118 of file vtkQtChartIndexRangeList.h.

void vtkQtChartIndexRange::setLeft ( vtkQtChartIndexRange left  )  [inline]

Sets the left child node.

Parameters:
left The new left child node.

Definition at line 123 of file vtkQtChartIndexRangeList.h.

vtkQtChartIndexRange* vtkQtChartIndexRange::getRight (  )  const [inline]

Gets the right child node.

Returns:
A pointer to the right child node.

Definition at line 129 of file vtkQtChartIndexRangeList.h.

void vtkQtChartIndexRange::setRight ( vtkQtChartIndexRange right  )  [inline]

Sets the right child node.

Parameters:
right The new right child node.

Definition at line 134 of file vtkQtChartIndexRangeList.h.


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

Generated on Mon Sep 27 18:44:13 2010 for VTK by  doxygen 1.5.6