itk::ArrowSpatialObject< TDimension > Class Template Reference

Representation of a Arrow based on the spatial object classes. More...

#include <itkArrowSpatialObject.h>

Inheritance diagram for itk::ArrowSpatialObject< TDimension >:

Collaboration diagram for itk::ArrowSpatialObject< TDimension >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TransformType::MatrixType	MatrixType
typedef SmartPointer< Self >	Pointer
typedef Point< double, TDimension >	PointType
typedef double	ScalarType
typedef ArrowSpatialObject	Self
typedef SpatialObject< TDimension >	Superclass
typedef Superclass::TransformType	TransformType
typedef Vector< double, TDimension >	VectorType
Public Member Functions
bool	ComputeLocalBoundingBox () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual VectorType	GetDirection () const
virtual const double &	GetLength ()
virtual const char *	GetNameOfClass () const
virtual PointType	GetPosition () const
virtual bool	IsInside (const PointType &point) const
bool	IsInside (const PointType &point, unsigned int depth, char *name) const
void	SetDirection (float x, float y, float z)
void	SetDirection (float x, float y)
void	SetLength (double length)
void	SetPosition (float x, float y, float z)
void	SetPosition (float x, float y)
void	SetPosition (const PointType &p)
void	SetDirection (const VectorType &d)
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	ArrowSpatialObject ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
void	UpdateTransform ()
virtual	~ArrowSpatialObject ()
Private Member Functions
	ArrowSpatialObject (const Self &)
void	operator= (const Self &)
Private Attributes
VectorType	m_Direction
double	m_Length
PointType	m_Position

---

Detailed Description

template<unsigned int TDimension = 3>
class itk::ArrowSpatialObject< TDimension >

Representation of a Arrow based on the spatial object classes.

A ArrowSpatialObject represents a Arrow by serving as the parent of the elements of the Arrow. Since any itk::SpatialObject can have children (see SpatialObject::GetChildren()), this class needs no additional methods.

Definition at line 38 of file itkArrowSpatialObject.h.

---

Member Typedef Documentation

template<unsigned int TDimension = 3>

typedef SmartPointer< const Self > itk::ArrowSpatialObject< TDimension >::ConstPointer

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 46 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

typedef TransformType::MatrixType itk::ArrowSpatialObject< TDimension >::MatrixType

Definition at line 51 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SmartPointer< Self > itk::ArrowSpatialObject< TDimension >::Pointer

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 45 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Point< double, TDimension > itk::ArrowSpatialObject< TDimension >::PointType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 49 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

typedef double itk::ArrowSpatialObject< TDimension >::ScalarType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 47 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

typedef ArrowSpatialObject itk::ArrowSpatialObject< TDimension >::Self

Standard class typedefs.

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 43 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SpatialObject< TDimension > itk::ArrowSpatialObject< TDimension >::Superclass

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 44 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::TransformType itk::ArrowSpatialObject< TDimension >::TransformType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 50 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Vector< double, TDimension > itk::ArrowSpatialObject< TDimension >::VectorType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 48 of file itkArrowSpatialObject.h.

---

Constructor & Destructor Documentation

template<unsigned int TDimension = 3>

itk::ArrowSpatialObject< TDimension >::ArrowSpatialObject

(

)

[protected]

template<unsigned int TDimension = 3>

virtual itk::ArrowSpatialObject< TDimension >::~ArrowSpatialObject

(

)

[protected, virtual]

template<unsigned int TDimension = 3>

itk::ArrowSpatialObject< TDimension >::ArrowSpatialObject

(

const Self &

)

[private]

---

Member Function Documentation

template<unsigned int TDimension = 3>

bool itk::ArrowSpatialObject< TDimension >::ComputeLocalBoundingBox

(

)

const [virtual]

Compute the local bounding box

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual::itk::LightObject::Pointer itk::ArrowSpatialObject< TDimension >::CreateAnother

(

void

)

const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual VectorType itk::ArrowSpatialObject< TDimension >::GetDirection

(

)

const [virtual]

template<unsigned int TDimension = 3>

virtual const double& itk::ArrowSpatialObject< TDimension >::GetLength

(

)

[virtual]

Get the length of the arrow

template<unsigned int TDimension = 3>

virtual const char* itk::ArrowSpatialObject< TDimension >::GetNameOfClass

(

)

const [virtual]

Method for creation through the object factory.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual PointType itk::ArrowSpatialObject< TDimension >::GetPosition

(

)

const [virtual]

template<unsigned int TDimension = 3>

virtual bool itk::ArrowSpatialObject< TDimension >::IsInside

(

const PointType &

point

)

const [virtual]

Test whether a point is inside or outside the object For computational speed purposes, it is faster if the method does not check the name of the class and the current depth

template<unsigned int TDimension = 3>

bool itk::ArrowSpatialObject< TDimension >::IsInside	(	const PointType &	point,
		unsigned int	depth,
		char *	name
	)		const

Returns true if the point is inside the line, false otherwise.

template<unsigned int TDimension = 3>

static Pointer itk::ArrowSpatialObject< TDimension >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

void itk::ArrowSpatialObject< TDimension >::operator=

(

const Self &

)

[private]

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual void itk::ArrowSpatialObject< TDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

Method to print the object.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

void itk::ArrowSpatialObject< TDimension >::SetDirection	(	float	x,
		float	y,
		float	z
	)		[inline]

Definition at line 101 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

void itk::ArrowSpatialObject< TDimension >::SetDirection

(

const VectorType &

d

)

[inline]

Set the direction of the arrow

Definition at line 85 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

void itk::ArrowSpatialObject< TDimension >::SetDirection	(	float	x,
		float	y
	)		[inline]

Definition at line 94 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

void itk::ArrowSpatialObject< TDimension >::SetLength

(

double

length

)

Set the length of the arrow

template<unsigned int TDimension = 3>

void itk::ArrowSpatialObject< TDimension >::SetPosition	(	float	x,
		float	y
	)		[inline]

Definition at line 69 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

void itk::ArrowSpatialObject< TDimension >::SetPosition

(

const PointType &

p

)

[inline]

Set the position of the arrow

Definition at line 60 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

void itk::ArrowSpatialObject< TDimension >::SetPosition	(	float	x,
		float	y,
		float	z
	)		[inline]

Definition at line 76 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

void itk::ArrowSpatialObject< TDimension >::UpdateTransform

(

)

[protected]

Update the transformation given the position and the direction

---

Member Data Documentation

template<unsigned int TDimension = 3>

VectorType itk::ArrowSpatialObject< TDimension >::m_Direction [private]

Definition at line 142 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

double itk::ArrowSpatialObject< TDimension >::m_Length [private]

Definition at line 144 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>

PointType itk::ArrowSpatialObject< TDimension >::m_Position [private]

Definition at line 143 of file itkArrowSpatialObject.h.

---

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

• itkArrowSpatialObject.h