IGSTK
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
igstk::ToolProjectionObjectRepresentation Class Reference

This class provides a visual representation of a ToolProjectionObject. More...

#include <igstkToolProjectionObjectRepresentation.h>

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

Public Types

typedef
ReslicerPlaneType::VectorType 
VectorType
 
typedef ToolProjectionSpatialObject ToolProjectionSpatialObjectType
 
- Public Types inherited from igstk::ObjectRepresentation
typedef double OpacityType
 Type for representing the opacity of the object. More...
 
- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs. More...
 
typedef ::itk::Object Superclass
 
typedef ::itk::SmartPointer< SelfPointer
 
typedef ::itk::SmartPointer
< const Self
ConstPointer
 
typedef igstk::Logger LoggerType
 

Public Member Functions

void RequestSetReslicePlaneSpatialObject (const ReslicerPlaneType *planeSpatialObject)
 Provides the reslicing plane onto which the tool is projected. More...
 
Pointer Copy () const
 Return a copy of the current object representation. More...
 
void RequestSetToolProjectionObject (const ToolProjectionSpatialObjectType *toolProjectionObject)
 Connect this representation class to the spatial object. More...
 
virtual void SetVisibility (bool visible)
 
void SetLineWidth (double LineWidth)
 Set/Get line width. More...
 
virtual double GetLineWidth ()
 
- Public Member Functions inherited from igstk::ObjectRepresentation
void SetColor (ColorScalarType r, ColorScalarType g, ColorScalarType b)
 Set the color. More...
 
ColorScalarType GetRed () const
 Get each color component. More...
 
ColorScalarType GetGreen () const
 
ColorScalarType GetBlue () const
 
virtual void SetOpacity (OpacityType alpha)
 Set/Get the opacity. More...
 
virtual OpacityType GetOpacity ()
 
virtual ActorsListType GetActors ()
 Get the VTK actors. More...
 
virtual void RequestUpdateRepresentation (const TimeStamp &time, const CoordinateSystem *cs)
 Update the visual representation with changes in the geometry. More...
 
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
 
void SetLogger (LoggerType *logger)
 Connect the Logger for this class. More...
 
void RemoveObserver (unsigned long tag) const
 

Public Attributes

igstkStandardClassTraitsMacro(ToolProjectionObjectRepresentation,
ObjectRepresentation) public
typedef
ReslicerPlaneType::Pointer 
ReslicerPlanePointerType
 Macro with standard traits declarations. More...
 
- Public Attributes inherited from igstk::ObjectRepresentation
igstkStandardAbstractClassTraitsMacro(ObjectRepresentation,
Object) public typedef double 
ColorScalarType
 Macro with standard traits declarations. More...
 

Protected Member Functions

 ToolProjectionObjectRepresentation (void)
 
virtual ~ToolProjectionObjectRepresentation (void)
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information. More...
 
void CreateActors ()
 Create the VTK actors. More...
 
virtual bool VerifyTimeStamp () const
 Verify time stamp. More...
 
- Protected Member Functions inherited from igstk::ObjectRepresentation
 ObjectRepresentation (void)
 
 ~ObjectRepresentation (void)
 
void AddActor (vtkProp *)
 Add an actor to the list. More...
 
virtual void DeleteActors ()
 Empty the list of actors. More...
 
void RequestSetSpatialObject (const SpatialObject *spatialObject)
 Request the state machine to set a Spatial Object. More...
 
TimeStamp GetRenderTimeStamp () const
 Get Time stamp for the time at which the next rendering will take place. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
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. More...
 
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
 
- Protected Attributes inherited from igstk::ObjectRepresentation
ActorsListType m_Actors
 
OpacityType m_Opacity
 

Detailed Description

This class provides a visual representation of a ToolProjectionObject.

This class displays the projection of a tool spatial object on top of a reslicing plane.

See Also
ToolProjectionObject

Definition at line 45 of file igstkToolProjectionObjectRepresentation.h.

Member Typedef Documentation

typedef ReslicerPlaneType::VectorType igstk::ToolProjectionObjectRepresentation::VectorType

Definition at line 62 of file igstkToolProjectionObjectRepresentation.h.

Definition at line 64 of file igstkToolProjectionObjectRepresentation.h.

Constructor & Destructor Documentation

igstk::ToolProjectionObjectRepresentation::ToolProjectionObjectRepresentation ( void  )
protected
virtual igstk::ToolProjectionObjectRepresentation::~ToolProjectionObjectRepresentation ( void  )
protectedvirtual

Member Function Documentation

void igstk::ToolProjectionObjectRepresentation::RequestSetReslicePlaneSpatialObject ( const ReslicerPlaneType *  planeSpatialObject)

Provides the reslicing plane onto which the tool is projected.

Pointer igstk::ToolProjectionObjectRepresentation::Copy ( ) const

Return a copy of the current object representation.

void igstk::ToolProjectionObjectRepresentation::RequestSetToolProjectionObject ( const ToolProjectionSpatialObjectType toolProjectionObject)

Connect this representation class to the spatial object.

virtual void igstk::ToolProjectionObjectRepresentation::SetVisibility ( bool  visible)
virtual
void igstk::ToolProjectionObjectRepresentation::SetLineWidth ( double  LineWidth)

Set/Get line width.

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

Print object information.

Reimplemented from igstk::ObjectRepresentation.

void igstk::ToolProjectionObjectRepresentation::CreateActors ( )
protectedvirtual

Create the VTK actors.

Implements igstk::ObjectRepresentation.

virtual bool igstk::ToolProjectionObjectRepresentation::VerifyTimeStamp ( ) const
protectedvirtual

Verify time stamp.

Use the reslicing tool transform to verify the time stamp

Reimplemented from igstk::ObjectRepresentation.

Member Data Documentation

igstkStandardClassTraitsMacro ( ToolProjectionObjectRepresentation, ObjectRepresentation ) public typedef ReslicerPlaneType::Pointer igstk::ToolProjectionObjectRepresentation::ReslicerPlanePointerType

Macro with standard traits declarations.

Typedefs

Definition at line 51 of file igstkToolProjectionObjectRepresentation.h.


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