CustusX  22.04-rc5
An IGT application
cx::Rep Class Referenceabstract

Abstract interface for entities that can be added to a View. More...

#include <cxRep.h>

Inheritance diagram for cx::Rep:
cx::RepImpl cx::AxesRep cx::CrossHairRep2D cx::DataMetricRep cx::DisplayTextRep cx::FiberBundleRep cx::GeometricRep cx::GeometricRep2D cx::Image2DRep3D cx::LandmarkRep cx::MehdiGPURayCastMultiVolumeRepBase cx::MetricNamesRep cx::OrientationAnnotation3DRep cx::OrientationAnnotationRep cx::OrientationAnnotationSmartRep cx::PickerRep cx::SlicePlanes3DMarkerIn2DRep cx::SlicePlanes3DRep cx::SliceRepSW cx::Slices3DRep cx::Stream2DRep3D cx::Texture3DSlicerRep cx::ToolRep2D cx::ToolRep3D cx::VideoFixedPlaneRep cx::VolumetricBaseRep

Public Member Functions

virtual ~Rep ()
 
virtual QString getType () const =0
 
virtual void connectToView (ViewPtr theView)=0
 
virtual void disconnectFromView (ViewPtr theView)=0
 
virtual bool isConnectedToView (ViewPtr theView) const =0
 
virtual void setName (QString name)=0
 
virtual QString getName () const =0
 
virtual QString getUid () const =0
 
virtual void printSelf (std::ostream &os, Indent indent)=0
 

Detailed Description

Abstract interface for entities that can be added to a View.

Rep (Representation) is the interface that all Representations in ssc must implement.

The default implementation can be found in RepImpl. Inherit from that when implementing concrete classes.

Definition at line 43 of file cxRep.h.

Constructor & Destructor Documentation

virtual cx::Rep::~Rep ( )
inlinevirtual

Definition at line 47 of file cxRep.h.

Member Function Documentation

virtual void cx::Rep::connectToView ( ViewPtr  theView)
pure virtual

Do not use this method! It is only used by View to set up an internal connection between the two.

Parameters
theViewThe view to add this representation to.
Returns

Implemented in cx::RepImpl.

virtual void cx::Rep::disconnectFromView ( ViewPtr  theView)
pure virtual

Do not use this method! It is only used by View to tear down an internal connection between the two.

Parameters
theViewThe view to disconnect from.
Returns

Implemented in cx::RepImpl.

virtual QString cx::Rep::getName ( ) const
pure virtual
Returns
a user-friendly name for this instance

Implemented in cx::RepImpl.

virtual QString cx::Rep::getUid ( ) const
pure virtual

Return an unique id for this instance, i.e. unique over all Rep instances.

Returns
the unique id.

Implemented in cx::RepImpl.

virtual bool cx::Rep::isConnectedToView ( ViewPtr  theView) const
pure virtual

Traverse the vector of views to see if this Representation is connected to one of them.

Parameters
theViewA view pointer.
Returns
True if theView was found in the internal vector of View pointers. false otherwise.

Implemented in cx::RepImpl.

virtual void cx::Rep::printSelf ( std::ostream &  os,
Indent  indent 
)
pure virtual
virtual void cx::Rep::setName ( QString  name)
pure virtual

Set the name of this Rep. This is useful for context-menus in Views and other user interaction constructs.

Parameters
nameThe user-friendly name for this instance.

Implemented in cx::RepImpl.


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