IGSTK
Public Member Functions | Protected Member Functions | List of all members
igstk::BoxObjectRepresentation Class Reference

This class represents a box object. More...

#include <igstkBoxObjectRepresentation.h>

Inheritance diagram for igstk::BoxObjectRepresentation:
Inheritance graph
[legend]
Collaboration diagram for igstk::BoxObjectRepresentation:
Collaboration graph
[legend]

Public Member Functions

void RequestSetBoxObject (const BoxSpatialObjectType *boxObject)
 Connect this representation class to the spatial object.
- Public Member Functions inherited from igstk::ObjectRepresentation
void SetColor (ColorScalarType r, ColorScalarType g, ColorScalarType b)
 Set the color.
ColorScalarType GetRed () const
 Get each color component.
ColorScalarType GetGreen () const
ColorScalarType GetBlue () const
virtual void SetOpacity (OpacityType alpha)
 Set/Get the opacity.
virtual OpacityType GetOpacity ()
virtual ActorsListType GetActors ()
 Get the VTK actors.
virtual void RequestUpdateRepresentation (const TimeStamp &time, const CoordinateSystem *cs)
 Update the visual representation with changes in the geometry.
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
void SetLogger (LoggerType *logger)
 Connect the Logger for this class.
void RemoveObserver (unsigned long tag) const

Protected Member Functions

 BoxObjectRepresentation (void)
virtual ~BoxObjectRepresentation (void)
 BoxObjectRepresentation (const Self &)
void operator= (const Self &)
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information.
void CreateActors ()
 Create the VTK actors.
- Protected Member Functions inherited from igstk::ObjectRepresentation
 ObjectRepresentation (void)
 ~ObjectRepresentation (void)
void AddActor (vtkProp *)
 Add an actor to the list.
virtual void DeleteActors ()
 Empty the list of actors.
void RequestSetSpatialObject (const SpatialObject *spatialObject)
 Request the state machine to set a Spatial Object.
virtual bool VerifyTimeStamp () const
 Verify the time stamp.
TimeStamp GetRenderTimeStamp () const
 Get Time stamp for the time at which the next rendering will take place.
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator.
virtual ~Object (void)
void RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
 Register observed objects in an internal array so that they can be disconnected upon destruction.
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects.

Additional Inherited Members

- Public Types inherited from igstk::ObjectRepresentation
typedef double OpacityType
 Type for representing the opacity of the object.
- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
- Public Attributes inherited from igstk::ObjectRepresentation
igstkStandardAbstractClassTraitsMacro(ObjectRepresentation,
Object) public typedef double 
ColorScalarType
 Macro with standard traits declarations.
- Protected Attributes inherited from igstk::ObjectRepresentation
ActorsListType m_Actors
OpacityType m_Opacity

Detailed Description

This class represents a box object.

The parameters of the object are the height of the object, and the radius. Default representation axis is X. The cylindrical object is rendered in a VTK scene using the vtkCubeSource object.

igstkBoxObjectRepresentation.png
State Machine Diagram

Definition at line 46 of file igstkBoxObjectRepresentation.h.

Constructor & Destructor Documentation

igstk::BoxObjectRepresentation::BoxObjectRepresentation ( void  )
protected
virtual igstk::BoxObjectRepresentation::~BoxObjectRepresentation ( void  )
protectedvirtual
igstk::BoxObjectRepresentation::BoxObjectRepresentation ( const Self )
protected

Member Function Documentation

void igstk::BoxObjectRepresentation::RequestSetBoxObject ( const BoxSpatialObjectType *  boxObject)

Connect this representation class to the spatial object.

void igstk::BoxObjectRepresentation::operator= ( const Self )
protected

Reimplemented from igstk::ObjectRepresentation.

virtual void igstk::BoxObjectRepresentation::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

Print object information.

Reimplemented from igstk::ObjectRepresentation.

void igstk::BoxObjectRepresentation::CreateActors ( )
protectedvirtual

Create the VTK actors.

Implements igstk::ObjectRepresentation.


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