Referential: marker for transformations, with an associated color. More...

#include <anatomist/reference/Referential.h>

Collaboration diagram for anatomist::Referential:

[legend]

Public Member Functions
	Referential ()

	Referential (const std::string &filename)

	Referential (std::set< AObject * > &)

	Referential (std::set< AWindow * > &)

	Referential (const Referential &ref)

virtual	~Referential ()

Referential &	operator= (const Referential &)

std::set< AObject * >	AnaObj (void) const
	objects which are currently in this referential

std::set< AWindow * >	AnaWin (void) const
	windows which are currently in this referential

AimsRGB	Color () const

void	setColor (const AimsRGB &col)

int	index () const
	Unique index, 0 is always the central referential.

void	AddObject (AObject *)
	Ajoute un objet dans la liste des objets.

void	AddWindow (AWindow *)
	Ajoute une fenetre dans la liste des fenetres.

void	RemoveObject (AObject *)
	Enleve un objet de la liste des objets.

void	RemoveWindow (AWindow *)
	Enleve une fenetre de la liste des fenetres.

bool	destroying () const

carto::UUID	uuid () const

const aims::PythonHeader &	header () const

aims::PythonHeader &	header ()

bool	load (const std::string &filename)

std::string	filename () const

bool	isDirect () const

bool	hidden () const
	a hidden referential does not appear in the GUI.

Static Public Member Functions
static Referential *	referentialOfUUID (const carto::UUID &uuid)

static Referential *	referentialOfUUID (const std::string &uuid)

static Referential *	acPcReferential ()

static Referential *	mniTemplateReferential ()

static Referential *	giftiTalairachReferential ()

static Referential *	referentialOfNameOrUUID (const AObject *obj, const std::string &refname)
	tries to find a ref in the referentials property list

static Referential *	referentialOfName (const std::string &refname)
	WARNING: a referential may not have a unique name.

static void	clearUnusedReferentials ()

static bool	mergeReferentials (Referential r1, Referential r2)
	merge 2 unconnected referential or connected by identity.

static void	mergeIdenticalReferentials ()

Protected Member Functions
AimsRGB	NewColor ()
	Retourne une nouvelle couleur.

Protected Attributes
std::set< AObject * >	_anaObj

std::set< AWindow * >	_anaWin

AimsRGB	_color

int	_indCol
	color index

bool	_destroying

aims::PythonHeader *	_header

std::string	_filename

carto::Mutex	_mutex

Detailed Description

Referential: marker for transformations, with an associated color.

Definition at line 55 of file Referential.h.

Constructor & Destructor Documentation

◆ Referential() [1/5]

anatomist::Referential::Referential ( )

Referenced by acPcReferential(), giftiTalairachReferential(), mergeReferentials(), mniTemplateReferential(), operator=(), Referential(), referentialOfName(), referentialOfNameOrUUID(), referentialOfUUID(), and referentialOfUUID().

◆ Referential() [2/5]

anatomist::Referential::Referential ( const std::string & filename )

References filename().

◆ Referential() [3/5]

anatomist::Referential::Referential ( std::set< AObject * > & )

◆ Referential() [4/5]

anatomist::Referential::Referential ( std::set< AWindow * > & )

◆ Referential() [5/5]

anatomist::Referential::Referential ( const Referential & ref )

References Referential().

◆ ~Referential()

virtual anatomist::Referential::~Referential ( )

virtual

Member Function Documentation

◆ acPcReferential()

static Referential * anatomist::Referential::acPcReferential ( )

static

References Referential().

◆ AddObject()

void anatomist::Referential::AddObject ( AObject * )

Ajoute un objet dans la liste des objets.

◆ AddWindow()

void anatomist::Referential::AddWindow ( AWindow * )

Ajoute une fenetre dans la liste des fenetres.

◆ AnaObj()

std::set< AObject * > anatomist::Referential::AnaObj ( void ) const

inline

objects which are currently in this referential

Definition at line 68 of file Referential.h.

References _anaObj.

◆ AnaWin()

std::set< AWindow * > anatomist::Referential::AnaWin ( void ) const

inline

windows which are currently in this referential

Definition at line 70 of file Referential.h.

References _anaWin.

◆ clearUnusedReferentials()

static void anatomist::Referential::clearUnusedReferentials ( )

static

◆ Color()

AimsRGB anatomist::Referential::Color ( ) const

inline

Definition at line 71 of file Referential.h.

References _color.

◆ destroying()

bool anatomist::Referential::destroying ( ) const

inline

Definition at line 83 of file Referential.h.

References _destroying.

◆ filename()

std::string anatomist::Referential::filename ( ) const

Referenced by load(), and Referential().

◆ giftiTalairachReferential()

static Referential * anatomist::Referential::giftiTalairachReferential ( )

static

References Referential().

◆ header() [1/2]

aims::PythonHeader & anatomist::Referential::header ( )

inline

Definition at line 86 of file Referential.h.

References _header.

◆ header() [2/2]

const aims::PythonHeader & anatomist::Referential::header ( ) const

inline

Definition at line 85 of file Referential.h.

References _header.

◆ hidden()

bool anatomist::Referential::hidden ( ) const

a hidden referential does not appear in the GUI.

This function is merely a shortcut to the header property "hidden".

◆ index()

int anatomist::Referential::index ( ) const

inline

Unique index, 0 is always the central referential.

Definition at line 74 of file Referential.h.

References _indCol.

◆ isDirect()

bool anatomist::Referential::isDirect ( ) const

◆ load()

bool anatomist::Referential::load ( const std::string & filename )

References filename().

◆ mergeIdenticalReferentials()

static void anatomist::Referential::mergeIdenticalReferentials ( )

static

◆ mergeReferentials()

static bool anatomist::Referential::mergeReferentials	(	Referential *	r1,
		Referential *	r2 )

static

merge 2 unconnected referential or connected by identity.

r2 will be deleted, objects/windows in ref r2 will be moved to r1. If r2 is a non-destructible referential (AC/PC...) then r1 will be deleted.

Returns: false if r1 and r2 are connected by a non-identity transform.

References Referential().

◆ mniTemplateReferential()

static Referential * anatomist::Referential::mniTemplateReferential ( )

static

References Referential().

◆ NewColor()

AimsRGB anatomist::Referential::NewColor ( )

protected

Retourne une nouvelle couleur.

◆ operator=()

Referential & anatomist::Referential::operator= ( const Referential & )

References Referential().

◆ referentialOfName()

static Referential * anatomist::Referential::referentialOfName ( const std::string & refname )

static

WARNING: a referential may not have a unique name.

References Referential().

◆ referentialOfNameOrUUID()

static Referential * anatomist::Referential::referentialOfNameOrUUID	(	const AObject *	obj,
		const std::string &	refname )

static

tries to find a ref in the referentials property list

References Referential().

◆ referentialOfUUID() [1/2]

static Referential * anatomist::Referential::referentialOfUUID ( const carto::UUID & uuid )

static

References Referential(), and uuid().

◆ referentialOfUUID() [2/2]

static Referential * anatomist::Referential::referentialOfUUID ( const std::string & uuid )

static

References Referential(), and uuid().

◆ RemoveObject()

void anatomist::Referential::RemoveObject ( AObject * )

Enleve un objet de la liste des objets.

◆ RemoveWindow()

void anatomist::Referential::RemoveWindow ( AWindow * )

Enleve une fenetre de la liste des fenetres.

◆ setColor()

void anatomist::Referential::setColor ( const AimsRGB & col )

◆ uuid()

carto::UUID anatomist::Referential::uuid ( ) const

Referenced by referentialOfUUID(), and referentialOfUUID().

Member Data Documentation

◆ _anaObj

std::set<AObject*> anatomist::Referential::_anaObj

protected

Definition at line 116 of file Referential.h.

Referenced by AnaObj().

◆ _anaWin

std::set<AWindow*> anatomist::Referential::_anaWin

protected

Definition at line 117 of file Referential.h.

Referenced by AnaWin().

◆ _color

AimsRGB anatomist::Referential::_color

protected

Definition at line 118 of file Referential.h.

Referenced by Color().

◆ _destroying

bool anatomist::Referential::_destroying

protected

Definition at line 121 of file Referential.h.

Referenced by destroying().

◆ _filename

std::string anatomist::Referential::_filename

protected

Definition at line 125 of file Referential.h.

◆ _header

aims::PythonHeader* anatomist::Referential::_header

protected

Definition at line 122 of file Referential.h.

Referenced by header(), and header().

◆ _indCol

int anatomist::Referential::_indCol

protected

color index

Definition at line 120 of file Referential.h.

Referenced by index().

◆ _mutex

carto::Mutex anatomist::Referential::_mutex

protected

Definition at line 126 of file Referential.h.

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

anatomist/reference/Referential.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Referential() [1/5]

◆ Referential() [2/5]

◆ Referential() [3/5]

◆ Referential() [4/5]

◆ Referential() [5/5]

◆ ~Referential()

Member Function Documentation

◆ acPcReferential()

◆ AddObject()

◆ AddWindow()

◆ AnaObj()

◆ AnaWin()

◆ clearUnusedReferentials()

◆ Color()

◆ destroying()

◆ filename()

◆ giftiTalairachReferential()

◆ header() [1/2]

◆ header() [2/2]

◆ hidden()

◆ index()

◆ isDirect()

◆ load()

◆ mergeIdenticalReferentials()

◆ mergeReferentials()

◆ mniTemplateReferential()

◆ NewColor()

◆ operator=()

◆ referentialOfName()

◆ referentialOfNameOrUUID()

◆ referentialOfUUID() [1/2]

◆ referentialOfUUID() [2/2]

◆ RemoveObject()

◆ RemoveWindow()

◆ setColor()

◆ uuid()

Member Data Documentation

◆ _anaObj

◆ _anaWin

◆ _color

◆ _destroying

◆ _filename

◆ _header

◆ _indCol

◆ _mutex