XYZTransform Class Reference

#include <XYZTransform.h>

Inheritance diagram for XYZTransform:

[legend]Collaboration diagram for XYZTransform:

[legend]List of all members.

---

Detailed Description

A transform that transforms the X, Y and Z coordinates independently.

Author:

Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Oded Wurman <owurman@stanford.edu>

Definition at line 27 of file XYZTransform.h.

Public Member Functions
virtual double	aspectRatio () const
	Get the aspect ratio.
virtual XYZTransform *	clone () const
	Creates a new Transform object by copying an existing one.
virtual bool	isLinearInZ () const
	Returns true if Z axis is linear.
virtual const Range &	limitX () const
	Returns a Range whose values are the limits on the X coordinate.
virtual const Range &	limitY () const
	Returns a Range whose values are the limits on the Y coordinate.
virtual const Range &	limitZ () const
	Returns a Range whose values are the limits on the Z coordinate.
const std::string &	name () const
	Returns the name of the Transform.
virtual void	transform (std::vector< double > &x, std::vector< double > &y, std::vector< double > &z) const
virtual void	transform (double &x, double &y, double &z) const
virtual void	validate (Range &x, Range &y, Range &z) const
TransformBase *	xTransform () const
	Returns the transform function on the X axis.
	XYZTransform (const XYZTransform &)
	The copy constructor.
	XYZTransform (UnaryTransform *x, UnaryTransform *y, UnaryTransform *z)
	The following constructor takes three base constructors as arguments.
TransformBase *	yTransform () const
	Returns the transform function on the Y axis.
TransformBase *	zTransform () const
	Returns the transform function on the Z axis.
virtual	~XYZTransform ()
	The virtual destructor.
Protected Attributes
std::string	m_name
	Name of the Transform.
Private Attributes
UnaryTransform *	m_x
	The transform on the X axis.
UnaryTransform *	m_y
	The transform on the Y axis.
UnaryTransform *	m_z
	The transform on the Z axis.

---

Constructor & Destructor Documentation

XYZTransform	(	UnaryTransform *	x,
		UnaryTransform *	y,
		UnaryTransform *	z
	)

The following constructor takes three base constructors as arguments.

Definition at line 20 of file XYZTransform.cxx.

References TransformBase::m_name, XYZTransform::m_x, XYZTransform::m_y, and XYZTransform::m_z.

Referenced by XYZTransform::clone().

XYZTransform

(

const XYZTransform &

)

The copy constructor.

Definition at line 37 of file XYZTransform.cxx.

References UnaryTransform::clone(), XYZTransform::m_x, XYZTransform::m_y, and XYZTransform::m_z.

~XYZTransform

(

)

[virtual]

The virtual destructor.

Definition at line 30 of file XYZTransform.cxx.

References XYZTransform::m_x, XYZTransform::m_y, and XYZTransform::m_z.

---

Member Function Documentation

double aspectRatio

(

)

const [virtual, inherited]

Get the aspect ratio.

Reimplemented in AIR, AIR2, ARC, ARC2, BinaryTransform, Cartesian, Cartesian2, GlobalSinusoidal, GlobalSinusoidal2, HammerAito, HammerAito2, Lambert, Lambert2, Mercator, Mercator2, SIN, SIN2, STG, STG2, TAN, TAN2, and XYTransform.

Definition at line 50 of file TransformBase.cxx.

Referenced by CompositePlotter::getAspectRatio().

XYZTransform * clone

(

)

const [virtual]

Creates a new Transform object by copying an existing one.

Implements XYZTransformBase.

Definition at line 54 of file XYZTransform.cxx.

References XYZTransform::XYZTransform().

bool isLinearInZ

(

)

const [virtual]

Returns true if Z axis is linear.

Definition at line 123 of file XYZTransform.cxx.

References UnaryTransform::isLinear(), and XYZTransform::m_z.

const Range & limitX

(

)

const [virtual]

Returns a Range whose values are the limits on the X coordinate.

Definition at line 91 of file XYZTransform.cxx.

References UnaryTransform::limits(), and XYZTransform::m_x.

const Range & limitY

(

)

const [virtual]

Returns a Range whose values are the limits on the Y coordinate.

Definition at line 97 of file XYZTransform.cxx.

References UnaryTransform::limits(), and XYZTransform::m_y.

const Range & limitZ

(

)

const [virtual]

Returns a Range whose values are the limits on the Z coordinate.

Definition at line 103 of file XYZTransform.cxx.

References UnaryTransform::limits(), and XYZTransform::m_z.

const string & name

(

)

const [inherited]

Returns the name of the Transform.

Definition at line 45 of file TransformBase.cxx.

References TransformBase::m_name.

Referenced by BinaryTransform::BinaryTransform(), TransformXML::createElement(), DisplayController::getLog(), DisplayController::setLog(), Inspector::updateTransformTab(), and XYTransform::XYTransform().

void transform	(	std::vector< double > &	x,
		std::vector< double > &	y,
		std::vector< double > &	z
	)			const [virtual]

Definition at line 73 of file XYZTransform.cxx.

References XYZTransform::m_x, XYZTransform::m_y, XYZTransform::m_z, and UnaryTransform::transform().

void transform	(	double &	x,
		double &	y,
		double &	z
	)			const [virtual]

Definition at line 61 of file XYZTransform.cxx.

References XYZTransform::m_x, XYZTransform::m_y, XYZTransform::m_z, and UnaryTransform::transform().

void validate	(	Range &	x,
		Range &	y,
		Range &	z
	)			const [virtual]

Definition at line 83 of file XYZTransform.cxx.

References XYZTransform::m_x, XYZTransform::m_y, XYZTransform::m_z, and UnaryTransform::validate().

TransformBase * xTransform

(

)

const

Returns the transform function on the X axis.

Definition at line 108 of file XYZTransform.cxx.

References XYZTransform::m_x.

TransformBase * yTransform

(

)

const

Returns the transform function on the Y axis.

Definition at line 113 of file XYZTransform.cxx.

References XYZTransform::m_y.

TransformBase * zTransform

(

)

const

Returns the transform function on the Z axis.

Definition at line 118 of file XYZTransform.cxx.

References XYZTransform::m_z.

---

Member Data Documentation

std::string m_name [protected, inherited]

Name of the Transform.

Definition at line 42 of file TransformBase.h.

Referenced by AIR::AIR(), AIR2::AIR2(), ARC::ARC(), ARC2::ARC2(), BinaryTransform::BinaryTransform(), Cartesian::Cartesian(), Cartesian2::Cartesian2(), GlobalSinusoidal::GlobalSinusoidal(), GlobalSinusoidal2::GlobalSinusoidal2(), HammerAito::HammerAito(), HammerAito2::HammerAito2(), Lambert::Lambert(), Lambert2::Lambert2(), LinearTransform::LinearTransform(), LogTransform::LogTransform(), Mercator::Mercator(), Mercator2::Mercator2(), TransformBase::name(), SIN::SIN(), SIN2::SIN2(), STG::STG(), STG2::STG2(), TAN::TAN(), TAN2::TAN2(), TransformBase::TransformBase(), XYTransform::XYTransform(), XYZTransform::XYZTransform(), and XYZTransformBase::XYZTransformBase().

UnaryTransform* m_x [private]

The transform on the X axis.

Definition at line 31 of file XYZTransform.h.

Referenced by XYZTransform::limitX(), XYZTransform::transform(), XYZTransform::validate(), XYZTransform::xTransform(), XYZTransform::XYZTransform(), and XYZTransform::~XYZTransform().

UnaryTransform* m_y [private]

The transform on the Y axis.

Definition at line 34 of file XYZTransform.h.

Referenced by XYZTransform::limitY(), XYZTransform::transform(), XYZTransform::validate(), XYZTransform::XYZTransform(), XYZTransform::yTransform(), and XYZTransform::~XYZTransform().

UnaryTransform* m_z [private]

The transform on the Z axis.

Definition at line 37 of file XYZTransform.h.

Referenced by XYZTransform::isLinearInZ(), XYZTransform::limitZ(), XYZTransform::transform(), XYZTransform::validate(), XYZTransform::XYZTransform(), XYZTransform::zTransform(), and XYZTransform::~XYZTransform().

---

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

• XYZTransform.h
• XYZTransform.cxx

---