cx::RepImpl Class Reference

Default implementation of Rep. More...

#include <cxRepImpl.h>

Inheritance diagram for cx::RepImpl:

Public Member Functions
	RepImpl (const QString &uid="", const QString &name="")
virtual	~RepImpl ()
virtual QString	getType () const =0
virtual void	connectToView (ViewPtr theView)
virtual void	disconnectFromView (ViewPtr theView)
virtual bool	isConnectedToView (ViewPtr theView) const
void	setName (QString name)
QString	getName () const
QString	getUid () const
virtual void	printSelf (std::ostream &os, Indent indent)
Public Member Functions inherited from cx::Rep
virtual	~Rep ()

Static Public Member Functions
template<class REP >
static boost::shared_ptr< REP >	wrap_new (REP *object, QString uid)

Protected Slots
void	setModified ()

Protected Member Functions
ViewPtr	getView () const
vtkRendererPtr	getRenderer ()
RepPtr	getSelf ()
virtual void	onModifiedStartRender ()
virtual void	addRepActorsToViewRenderer (ViewPtr view)=0
virtual void	removeRepActorsFromViewRenderer (ViewPtr view)=0
virtual void	onEveryRender ()

Detailed Description

Default implementation of Rep.

Subclass from here to get a concrete class.

The connection to View is handled here, but subclasses must implement at least:

• getType()
• addRepActorsToViewRenderer()
• removeRepActorsFromViewRenderer().

Definition at line 42 of file cxRepImpl.h.

Constructor & Destructor Documentation

RepImpl()

cx::RepImpl::RepImpl ( const QString &  uid = "", const QString &  name = ""  )

explicit

Definition at line 22 of file cxRepImpl.cpp.

~RepImpl()

cx::RepImpl::~RepImpl ( )

virtual

Definition at line 31 of file cxRepImpl.cpp.

Member Function Documentation

addRepActorsToViewRenderer()

virtual void cx::RepImpl::addRepActorsToViewRenderer ( ViewPtr  view )

protectedpure virtual

Implemented in cx::SlicePlanes3DMarkerIn2DRep, cx::SlicePlanes3DRep, cx::LandmarkRep, cx::Image2DRep3D, cx::Texture3DSlicerRep, cx::GeometricRep, cx::VolumetricRep, cx::PickerRep, cx::ToolRep3D, cx::ToolRep2D, cx::OrientationAnnotationRep, cx::CrossHairRep2D, cx::OrientationAnnotationSmartRep, cx::Slices3DRep, cx::MetricNamesRep, cx::VideoFixedPlaneRep, cx::SliceRepSW, cx::FiberBundleRep, cx::DataMetricRep, cx::DisplayTextRep, cx::GeometricRep2D, cx::AxesRep, cx::OrientationAnnotation3DRep, cx::ToolMetricRep, cx::PointMetricRep2D, cx::PointMetricRep, cx::DistanceMetricRep2D, cx::SphereMetricRep2D, cx::PlaneMetricRep, and cx::Stream2DRep3D.

connectToView()

void cx::RepImpl::connectToView ( ViewPtr  theView )

virtual

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

Parameters

theView

The view to add this representation to.

Returns

Implements cx::Rep.

Definition at line 55 of file cxRepImpl.cpp.

disconnectFromView()

void cx::RepImpl::disconnectFromView ( ViewPtr  theView )

virtual

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

Parameters

theView

The view to disconnect from.

Returns

Implements cx::Rep.

Definition at line 65 of file cxRepImpl.cpp.

getName()

QString cx::RepImpl::getName ( ) const

virtual

Returns

a reps name

Implements cx::Rep.

Definition at line 40 of file cxRepImpl.cpp.

getRenderer()

vtkRendererPtr cx::RepImpl::getRenderer ( )

protected

Definition at line 88 of file cxRepImpl.cpp.

getSelf()

RepPtr cx::RepImpl::getSelf ( )

inlineprotected

Definition at line 79 of file cxRepImpl.h.

getType()

virtual QString cx::RepImpl::getType ( ) const

pure virtual

Returns

a string identifying the Rep type. Each suclass implement this with its own class name. Subclasses from other namespaces (such as cx and snw) should add that namespace as a prefix.

Implements cx::Rep.

Implemented in cx::SlicePlanes3DMarkerIn2DRep, cx::SlicePlanes3DRep, cx::LandmarkRep, cx::Image2DRep3D, cx::Texture3DSlicerRep, cx::VolumetricRep, cx::OrientationAnnotationRep, cx::PickerRep, cx::ToolRep3D, cx::Slices3DRep, cx::ToolRep2D, cx::AngleMetricRep, cx::VideoFixedPlaneRep, cx::CrossHairRep2D, cx::MetricNamesRep, cx::SphereMetricRep, cx::OrientationAnnotationSmartRep, cx::FiberBundleRep, cx::CustomMetricRep, cx::DistanceMetricRep, cx::DisplayTextRep, cx::SliceRepSW, cx::ToolMetricRep, cx::FrameMetricRep, cx::PointMetricRep, cx::PointMetricRep2D, cx::DonutMetricRep, cx::RegionOfInterestMetricRep, cx::GuideRep2D, cx::AxesRep, cx::PlaneMetricRep, cx::DistanceMetricRep2D, cx::SphereMetricRep2D, cx::OrientationAnnotation3DRep, cx::Stream2DRep3D, and cx::StreamRep3D.

getUid()

QString cx::RepImpl::getUid ( ) const

virtual

Returns

a reps unique id

Implements cx::Rep.

Definition at line 45 of file cxRepImpl.cpp.

getView()

ViewPtr cx::RepImpl::getView ( ) const

protected

Definition at line 83 of file cxRepImpl.cpp.

isConnectedToView()

bool cx::RepImpl::isConnectedToView ( ViewPtr  theView ) const

virtual

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

Parameters

theView

A view pointer.

Returns

True if theView was found in the internal vector of View pointers. false otherwise.

Implements cx::Rep.

Definition at line 50 of file cxRepImpl.cpp.

onEveryRender()

virtual void cx::RepImpl::onEveryRender ( )

inlineprotectedvirtual

Reimplemented in cx::CustomMetricRep.

Definition at line 85 of file cxRepImpl.h.

onModifiedStartRender()

virtual void cx::RepImpl::onModifiedStartRender ( )

inlineprotectedvirtual

Reimplemented in cx::PickerRep, cx::ToolRep3D, cx::ToolRep2D, cx::MetricNamesRep, cx::AngleMetricRep, cx::GuideRep2D, cx::PointMetricRep2D, cx::SphereMetricRep, cx::PointMetricRep, cx::ToolMetricRep, cx::DistanceMetricRep2D, cx::CustomMetricRep, cx::DistanceMetricRep, cx::SphereMetricRep2D, cx::FrameMetricRep, cx::PlaneMetricRep, cx::DonutMetricRep, and cx::RegionOfInterestMetricRep.

Definition at line 82 of file cxRepImpl.h.

printSelf()

void cx::RepImpl::printSelf ( std::ostream &  os, Indent  indent  )

virtual

Implements cx::Rep.

Reimplemented in cx::Texture3DSlicerRep, and cx::SliceRepSW.

Definition at line 76 of file cxRepImpl.cpp.

removeRepActorsFromViewRenderer()

virtual void cx::RepImpl::removeRepActorsFromViewRenderer ( ViewPtr  view )

protectedpure virtual

Implemented in cx::SlicePlanes3DMarkerIn2DRep, cx::SlicePlanes3DRep, cx::LandmarkRep, cx::Image2DRep3D, cx::Texture3DSlicerRep, cx::GeometricRep, cx::VolumetricRep, cx::PickerRep, cx::ToolRep3D, cx::ToolRep2D, cx::OrientationAnnotationRep, cx::CrossHairRep2D, cx::OrientationAnnotationSmartRep, cx::Slices3DRep, cx::MetricNamesRep, cx::VideoFixedPlaneRep, cx::SliceRepSW, cx::FiberBundleRep, cx::DataMetricRep, cx::DisplayTextRep, cx::GeometricRep2D, cx::AxesRep, cx::OrientationAnnotation3DRep, cx::ToolMetricRep, cx::PointMetricRep2D, cx::PointMetricRep, cx::DistanceMetricRep2D, cx::SphereMetricRep2D, cx::PlaneMetricRep, and cx::Stream2DRep3D.

setModified

void cx::RepImpl::setModified ( )

protectedslot

Definition at line 112 of file cxRepImpl.cpp.

setName()

void cx::RepImpl::setName ( QString  name )

virtual

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

Parameters

name	The user-friendly name for this instance.

Implements cx::Rep.

Definition at line 35 of file cxRepImpl.cpp.

wrap_new()

template<class REP >

static boost::shared_ptr<REP> cx::RepImpl::wrap_new ( REP *  object, QString  uid  )

inlinestatic

Usage: Define functions in each subclass with the signature: static REPPtr New(QString uid="") { return wrap_new(new REP(), uid); }

Definition at line 62 of file cxRepImpl.h.

---

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

• /mnt/bamboo/bamboo/buildagent/xml-data/build-dir/NN-RE-BU2/CX/CX/source/resource/view/Rep/cxRepImpl.h
• /mnt/bamboo/bamboo/buildagent/xml-data/build-dir/NN-RE-BU2/CX/CX/source/resource/view/Rep/cxRepImpl.cpp