itk::SpatialObjectProperty< TComponentType > Class Template Reference

#include <itkSpatialObjectProperty.h>

Inheritance diagram for itk::SpatialObjectProperty< TComponentType >:

Collaboration diagram for itk::SpatialObjectProperty< TComponentType >:

Detailed Description

template<typename TComponentType = float>
class itk::SpatialObjectProperty< TComponentType >

This class contains the objects properties such as colors, opacity, etc... it's templated over the representation to use for each color component.

Definition at line 35 of file itkSpatialObjectProperty.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef RGBAPixel< TComponentType >	PixelType
typedef SmartPointer< Self >	Pointer
typedef SpatialObjectProperty < TComponentType >	Self
typedef std::string	StringType
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
TComponentType	GetAlpha () const
TComponentType	GetBlue () const
const PixelType &	GetColor () const
TComponentType	GetGreen () const
unsigned long	GetMTime (void)
StringType	GetName () const
virtual const char *	GetNameOfClass () const
TComponentType	GetRed () const
void	SetAlpha (TComponentType a)
void	SetBlue (TComponentType b)
void	SetColor (const PixelType &color)
void	SetColor (TComponentType r, TComponentType g, TComponentType b)
void	SetGreen (TComponentType g)
void	SetName (const char *name)
void	SetRed (TComponentType r)
	SpatialObjectProperty ()
virtual	~SpatialObjectProperty ()
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Member Functions
void	Modified (void)
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
void	operator= (const Self &) ITK_DELETE_FUNCTION
	SpatialObjectProperty (const Self &) ITK_DELETE_FUNCTION

Private Attributes
PixelType	m_Color
unsigned long	m_MTime
StringType	m_Name

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TComponentType = float>

typedef SmartPointer< const Self > itk::SpatialObjectProperty< TComponentType >::ConstPointer

Definition at line 46 of file itkSpatialObjectProperty.h.

template<typename TComponentType = float>

typedef RGBAPixel< TComponentType > itk::SpatialObjectProperty< TComponentType >::PixelType

Definition at line 42 of file itkSpatialObjectProperty.h.

template<typename TComponentType = float>

typedef SmartPointer< Self > itk::SpatialObjectProperty< TComponentType >::Pointer

Definition at line 45 of file itkSpatialObjectProperty.h.

template<typename TComponentType = float>

typedef SpatialObjectProperty< TComponentType > itk::SpatialObjectProperty< TComponentType >::Self

Definition at line 40 of file itkSpatialObjectProperty.h.

template<typename TComponentType = float>

typedef std::string itk::SpatialObjectProperty< TComponentType >::StringType

Definition at line 43 of file itkSpatialObjectProperty.h.

template<typename TComponentType = float>

typedef LightObject itk::SpatialObjectProperty< TComponentType >::Superclass

Definition at line 41 of file itkSpatialObjectProperty.h.

Constructor & Destructor Documentation

template<typename TComponentType = float>

itk::SpatialObjectProperty< TComponentType >::SpatialObjectProperty

(

)

template<typename TComponentType = float>

virtual itk::SpatialObjectProperty< TComponentType >::~SpatialObjectProperty ( )

virtual

template<typename TComponentType = float>

itk::SpatialObjectProperty< TComponentType >::SpatialObjectProperty ( const Self &  )

private

Member Function Documentation

template<typename TComponentType = float>

virtual::itk::LightObject::Pointer itk::SpatialObjectProperty< TComponentType >::CreateAnother ( ) 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::LightObject.

template<typename TComponentType = float>

TComponentType itk::SpatialObjectProperty< TComponentType >::GetAlpha

(

)

const

template<typename TComponentType = float>

TComponentType itk::SpatialObjectProperty< TComponentType >::GetBlue

(

)

const

template<typename TComponentType = float>

const PixelType& itk::SpatialObjectProperty< TComponentType >::GetColor

(

)

const

template<typename TComponentType = float>

TComponentType itk::SpatialObjectProperty< TComponentType >::GetGreen

(

)

const

template<typename TComponentType = float>

unsigned long itk::SpatialObjectProperty< TComponentType >::GetMTime ( void  )

inline

Definition at line 80 of file itkSpatialObjectProperty.h.

References itk::SpatialObjectProperty< TComponentType >::m_MTime.

template<typename TComponentType = float>

StringType itk::SpatialObjectProperty< TComponentType >::GetName

(

)

const

template<typename TComponentType = float>

virtual const char* itk::SpatialObjectProperty< TComponentType >::GetNameOfClass ( ) const

virtual

Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information.

Reimplemented from itk::LightObject.

template<typename TComponentType = float>

TComponentType itk::SpatialObjectProperty< TComponentType >::GetRed

(

)

const

template<typename TComponentType = float>

void itk::SpatialObjectProperty< TComponentType >::Modified ( void  )

inlineprotected

Definition at line 86 of file itkSpatialObjectProperty.h.

References itk::SpatialObjectProperty< TComponentType >::m_MTime.

template<typename TComponentType = float>

static Pointer itk::SpatialObjectProperty< TComponentType >::New ( )

static

template<typename TComponentType = float>

void itk::SpatialObjectProperty< TComponentType >::operator= ( const Self &  )

private

template<typename TComponentType = float>

virtual void itk::SpatialObjectProperty< TComponentType >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::LightObject.

template<typename TComponentType = float>

void itk::SpatialObjectProperty< TComponentType >::SetAlpha

(

TComponentType

a

)

template<typename TComponentType = float>

void itk::SpatialObjectProperty< TComponentType >::SetBlue

(

TComponentType

b

)

template<typename TComponentType = float>

void itk::SpatialObjectProperty< TComponentType >::SetColor

(

const PixelType &

color

)

template<typename TComponentType = float>

void itk::SpatialObjectProperty< TComponentType >::SetColor	(	TComponentType	r,
		TComponentType	g,
		TComponentType	b
	)

template<typename TComponentType = float>

void itk::SpatialObjectProperty< TComponentType >::SetGreen

(

TComponentType

g

)

template<typename TComponentType = float>

void itk::SpatialObjectProperty< TComponentType >::SetName

(

const char *

name

)

template<typename TComponentType = float>

void itk::SpatialObjectProperty< TComponentType >::SetRed

(

TComponentType

r

)

Member Data Documentation

template<typename TComponentType = float>

PixelType itk::SpatialObjectProperty< TComponentType >::m_Color

private

Definition at line 92 of file itkSpatialObjectProperty.h.

template<typename TComponentType = float>

unsigned long itk::SpatialObjectProperty< TComponentType >::m_MTime

private

Definition at line 94 of file itkSpatialObjectProperty.h.

Referenced by itk::SpatialObjectProperty< TComponentType >::GetMTime(), and itk::SpatialObjectProperty< TComponentType >::Modified().

template<typename TComponentType = float>

StringType itk::SpatialObjectProperty< TComponentType >::m_Name

private

Definition at line 93 of file itkSpatialObjectProperty.h.

---

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

• itkSpatialObjectProperty.h