vtkTupleThreeD Class Reference
[C++/Common/Vtk/DataTypes]

The purpose of this class is to provide operations on three domain objects. More...

#include <vtkTupleThreeD.h>

Inheritance diagram for vtkTupleThreeD:

[legend]Collaboration diagram for vtkTupleThreeD:

[legend]List of all members.

Public Member Functions
	vtkTypeMacro (vtkTupleThreeD, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
	Print the state of this object.
void	value (double x, double y, double z)
	Specify the value of this object.
void	value (double a[3])
	Specify the value of this object.
void	value (float a[3])
	Specify the value of this object.
double	X () const
	Give the x value.
double	Y () const
	Give the y value.
double	Z () const
	Give z value.
vtkTupleThreeD &	operator= (const vtkTupleThreeD &rhs)
	Copy operator.
bool	operator== (const vtkTupleThreeD &rhs) const
	Equality operator.
bool	operator!= (const vtkTupleThreeD &rhs) const
	Inequality operator.
double	operator * (const vtkTupleThreeD &rhs)
	Dot product operator.
Static Public Member Functions
static vtkTupleThreeD *	New ()
	Instantiate a new object of this type.
Protected Member Functions
	vtkTupleThreeD ()
	Ctor.
	~vtkTupleThreeD ()
	Dtor.

---

Detailed Description

The purpose of this class is to provide operations on three domain objects.

Definition at line 16 of file vtkTupleThreeD.h.

---

Constructor & Destructor Documentation

vtkTupleThreeD::vtkTupleThreeD

(

)

[protected]

Ctor.

vtkTupleThreeD::~vtkTupleThreeD

(

)

[protected]

Dtor.

---

Member Function Documentation

static vtkTupleThreeD* vtkTupleThreeD::New

(

)

[static]

Instantiate a new object of this type.

This is the only method that objects of this type may be created.

Returns:

The new object.

Reimplemented from vtkObject.

vtkTupleThreeD::vtkTypeMacro	(	vtkTupleThreeD	,
		vtkObject
	)

void vtkTupleThreeD::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Print the state of this object.

Parameters:

	os	The output stream.
	indent	The indentation level. Used for formating output.

Reimplemented from vtkObject.

void vtkTupleThreeD::value	(	double	x,
		double	y,
		double	z
	)

Specify the value of this object.

Parameters:

	x	The x value.
	y	The x value.
	z	The z value.

void vtkTupleThreeD::value

(

double

a[3]

)

Specify the value of this object.

Parameters:

a

The value (x, y, z).

void vtkTupleThreeD::value

(

float

a[3]

)

Specify the value of this object.

Parameters:

a

The value (x, y, z).

double vtkTupleThreeD::X

(

)

const

Give the x value.

Returns:

X value.

double vtkTupleThreeD::Y

(

)

const

Give the y value.

Returns:

Y value.

double vtkTupleThreeD::Z

(

)

const

Give z value.

Returns:

Z value.

vtkTupleThreeD& vtkTupleThreeD::operator=

(

const vtkTupleThreeD &

rhs

)

Copy operator.

Parameters:

rhs

The reference object

Returns:

This object.

bool vtkTupleThreeD::operator==

(

const vtkTupleThreeD &

rhs

)

const

Equality operator.

Parameters:

rhs

The reference object.

Returns:

True if this object is equal to the rhs.

bool vtkTupleThreeD::operator!=

(

const vtkTupleThreeD &

rhs

)

const

Inequality operator.

Parameters:

rhs

The reference object.

Returns:

True if this object is not equal to the rhs.

double vtkTupleThreeD::operator *

(

const vtkTupleThreeD &

rhs

)

Dot product operator.

Parameters:

rhs

The argument to be multiplied to this object.

Returns:

The product scalar.

---

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

• vtkTupleThreeD.h

Generated on Sat Nov 22 12:37:42 2008 for Swath Sonar by Doxygen 1.5.1