itk::SpatialObjectProperty< TComponentType > Class Template Reference
#include <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 Member Functions | |
| virtual Pointer | CreateAnother () const |
| virtual void | Delete () |
| TComponentType | GetAlpha (void) const |
| TComponentType | GetBlue (void) const |
| const PixelType & | GetColor (void) const |
| TComponentType | GetGreen (void) const |
| unsigned long | GetMTime (void) |
| StringType | GetName (void) const |
| virtual const char * | GetNameOfClass () const |
| TComponentType | GetRed (void) const |
| virtual int | GetReferenceCount () const |
| void | Print (std::ostream &os, Indent indent=0) const |
| virtual void | Register () const |
| void | SetAlpha (TComponentType a) |
| void | SetBlue (TComponentType b) |
| void | SetColor (TComponentType r, TComponentType g, TComponentType b) |
| void | SetColor (const PixelType &color) |
| void | SetGreen (TComponentType g) |
| void | SetName (const char *name) |
| void | SetRed (TComponentType r) |
| virtual void | SetReferenceCount (int) |
| SpatialObjectProperty () | |
| virtual void | UnRegister () const |
| virtual | ~SpatialObjectProperty () |
Static Public Member Functions | |
| static void | BreakOnError () |
| static Pointer | New () |
Protected Types | |
| typedef int | InternalReferenceCountType |
Protected Member Functions | |
| void | Modified (void) |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual void | PrintHeader (std::ostream &os, Indent indent) const |
| virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
Protected Attributes | |
| InternalReferenceCountType | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
Detailed Description
template<class 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.
Member Typedef Documentation
| typedef SmartPointer<const Self> itk::SpatialObjectProperty< TComponentType >::ConstPointer |
typedef int itk::LightObject::InternalReferenceCountType [protected, inherited] |
Define the type of the reference count according to the target. This allows the use of atomic operations
Definition at line 139 of file itkLightObject.h.
| typedef RGBAPixel< TComponentType > itk::SpatialObjectProperty< TComponentType >::PixelType |
Definition at line 42 of file itkSpatialObjectProperty.h.
| typedef SmartPointer<Self> itk::SpatialObjectProperty< TComponentType >::Pointer |
| typedef SpatialObjectProperty< TComponentType > itk::SpatialObjectProperty< TComponentType >::Self |
Standard clas typedefs.
Reimplemented from itk::LightObject.
Definition at line 40 of file itkSpatialObjectProperty.h.
| typedef std::string itk::SpatialObjectProperty< TComponentType >::StringType |
Definition at line 43 of file itkSpatialObjectProperty.h.
| typedef LightObject itk::SpatialObjectProperty< TComponentType >::Superclass |
Definition at line 41 of file itkSpatialObjectProperty.h.
Constructor & Destructor Documentation
| itk::SpatialObjectProperty< TComponentType >::SpatialObjectProperty | ( | ) |
| virtual itk::SpatialObjectProperty< TComponentType >::~SpatialObjectProperty | ( | ) | [virtual] |
Member Function Documentation
| static void itk::LightObject::BreakOnError | ( | ) | [static, inherited] |
This method is called when itkExceptionMacro executes. It allows the debugger to break on error.
| virtual Pointer itk::LightObject::CreateAnother | ( | ) | const [virtual, inherited] |
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 in itk::Object.
| virtual void itk::LightObject::Delete | ( | ) | [virtual, inherited] |
Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.
| TComponentType itk::SpatialObjectProperty< TComponentType >::GetAlpha | ( | void | ) | const |
| TComponentType itk::SpatialObjectProperty< TComponentType >::GetBlue | ( | void | ) | const |
| const PixelType& itk::SpatialObjectProperty< TComponentType >::GetColor | ( | void | ) | const |
| TComponentType itk::SpatialObjectProperty< TComponentType >::GetGreen | ( | void | ) | const |
| unsigned long itk::SpatialObjectProperty< TComponentType >::GetMTime | ( | void | ) | [inline] |
Definition at line 73 of file itkSpatialObjectProperty.h.
| StringType itk::SpatialObjectProperty< TComponentType >::GetName | ( | void | ) | const |
| 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.
| TComponentType itk::SpatialObjectProperty< TComponentType >::GetRed | ( | void | ) | const |
| virtual int itk::LightObject::GetReferenceCount | ( | ) | const [inline, virtual, inherited] |
Gets the reference count on this object.
Definition at line 106 of file itkLightObject.h.
| void itk::SpatialObjectProperty< TComponentType >::Modified | ( | void | ) | [inline, protected] |
Definition at line 78 of file itkSpatialObjectProperty.h.
| static Pointer itk::SpatialObjectProperty< TComponentType >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::LightObject.
| void itk::LightObject::Print | ( | std::ostream & | os, | |
| Indent | indent = 0 | |||
| ) | const [inherited] |
Cause the object to print itself out.
Referenced by itk::WeakPointer< ProcessObject >::Print().
| virtual void itk::LightObject::PrintHeader | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| void itk::SpatialObjectProperty< TComponentType >::PrintSelf | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual] |
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.
| virtual void itk::LightObject::PrintTrailer | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| virtual void itk::LightObject::Register | ( | ) | const [virtual, inherited] |
Increase the reference count (mark as used by another object).
Reimplemented in itk::Object.
| void itk::SpatialObjectProperty< TComponentType >::SetAlpha | ( | TComponentType | a | ) |
| void itk::SpatialObjectProperty< TComponentType >::SetBlue | ( | TComponentType | b | ) |
| void itk::SpatialObjectProperty< TComponentType >::SetColor | ( | TComponentType | r, | |
| TComponentType | g, | |||
| TComponentType | b | |||
| ) |
| void itk::SpatialObjectProperty< TComponentType >::SetColor | ( | const PixelType & | color | ) |
| void itk::SpatialObjectProperty< TComponentType >::SetGreen | ( | TComponentType | g | ) |
| void itk::SpatialObjectProperty< TComponentType >::SetName | ( | const char * | name | ) |
| void itk::SpatialObjectProperty< TComponentType >::SetRed | ( | TComponentType | r | ) |
| virtual void itk::LightObject::SetReferenceCount | ( | int | ) | [virtual, inherited] |
Sets the reference count on this object. This is a dangerous method, use it with care.
Reimplemented in itk::Object.
| virtual void itk::LightObject::UnRegister | ( | ) | const [virtual, inherited] |
Decrease the reference count (release by another object).
Reimplemented in itk::Object.
Member Data Documentation
InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited] |
Number of uses of this object by other objects.
Definition at line 144 of file itkLightObject.h.
SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited] |
Mutex lock to protect modification to the reference count
Definition at line 147 of file itkLightObject.h.
The documentation for this class was generated from the following file:
