The Anatomist class holds information about all data handled by Anatomist: the objects, the windows, and other application-wide lists. More...

#include <anatomist/application/Anatomist.h>

Inheritance diagram for anatomist::Anatomist:

[legend]

Collaboration diagram for anatomist::Anatomist:

[legend]

Public Types
enum	Cursor { Normal , Working }

Public Types inherited from carto::OptionsParser
typedef std::vector< std::string >	CommandLineArguments

Public Member Functions
	Anatomist (int argc, const char **argv, const std::string &documentation)

virtual	~Anatomist ()

virtual void	initialize ()

PaletteList &	palettes ()

const PaletteList &	palettes () const

virtual void	Refresh ()

void	NotifyMapWindow (AWindow *)

void	NotifyUnmapWindow (AWindow *)

virtual void	createControlWindow ()

ControlWindow *	getControlWindow () const

QWidget *	getQWidgetAncestor () const
	Gets an empty QWidget that is created in Anatomist application to become a default parent for all Anatomist windows. More...

virtual void	createReferentialWindow ()
	Create the referential window and update it. More...

ReferentialWindow *	getReferentialWindow () const

bool	hasWindow (const AWindow *win) const

int	groupWindows (std::set< AWindow * > &winL, int groupnum=-1)
	Links the given windows, and returns the new group number. More...

void	ungroupWindows (int group)
	Unlinks the windows with the given group number. More...

std::set< AWindow * >	getWindowsInGroup (int group)
	Retruns the set of windows in a given group. More...

void	NotifyWindowChange (AWindow *win)

int	destroyObject (AObject *, bool verbose=true)
	Destroys an object if possible. More...

std::set< AObject * >	destroyObjects (const std::set< AObject * > &, bool verbose=true)
	Destroys an object if possible. More...

bool	hasObject (const AObject *obj) const

void	mapObject (AObject *obj)
	Makes an object visible (ie seen in control window(s)) More...

void	unmapObject (AObject *obj)
	Makes an object unvisible (ie not seen in control window(s)) More...

virtual void	UpdateInterface ()

std::string	makeObjectName (const std::string &name)
	Builds a unique object name. More...

std::set< AObject * >	getObjects () const

std::set< AWindow * >	getWindows () const

const std::set< Referential * > &	getReferentials () const

bool	hasReferential (const Referential *)

Transformation *	getTransformation (const Referential , const Referential )

const Transformation *	getTransformation (const Referential , const Referential ) const

std::list< AObject * >	loadObject (const std::string &filename, const std::string &objname="", carto::Object options=carto::none())

void	registerObject (AObject *obj, int inctrl=1)

void	unregisterObject (AObject *obj)

void	releaseObject (AObject *obj)
	releases the reference counter kept in Anatomist application for the given object, so that external reference counting will behave normally. More...

void	takeObjectRef (AObject *obj)
	change object reference type to WeakShared (standard in anatomist) More...

void	NotifyObjectChange (AObject *obj)

void	registerSubObject (MObject parent, AObject obj)

void	registerReferential (Referential *ref)

void	unregisterReferential (Referential *ref)

void	registerWindow (AWindow *win)

void	unregisterWindow (AWindow *win)

void	releaseWindow (AWindow *win)
	releases the reference counter kept in Anatomist application for the given window, so that external reference counting will behave normally. More...

void	takeWindowRef (AWindow *obj)
	change window reference type to WeakShared (standard in anatomist) More...

void	registerObjectName (const std::string &name, AObject *obj)

void	unregisterObjectName (const std::string &name)

bool	initialized () const

const CommandWriter &	historyWriter () const

CommandWriter &	historyWriter ()

GlobalConfiguration *	config ()

void	setCursor (Cursor c)
	Sets the shape of the mouse cursor on every window. More...

const std::string &	objectsFileFilter () const

void	addObjectsFileFilter (const std::string &filter)

virtual bool	glMakeCurrent ()

Referential *	centralReferential () const

std::string	language () const

int	userLevel () const
	The user level drives the GUI to show or hide some features for simplicity or richness. More...

void	setUserLevel (int)

void	setLastPosition (const Point3df &pos, Referential *fromref=0)

void	setLastPosition (const std::vector< float > &pos, Referential *fromref=0)

Point3df	lastPosition (const Referential *toref=0) const

std::vector< float >	lastFullPosition (const Referential *toref=0) const

bool	destroying () const
	returns true if the Anatomist application is currently being destroyed More...

void	updateFileDialogObjectsFilter ()
	setup/update extensions list for readable files More...

void	lockObjects (bool locked=true)
	lock / unlock the objects list mutex, used in threaded load operations More...

Public Member Functions inherited from aims::AimsApplication
	AimsApplication (int argc, const char **argv, const std::string &documentation)

	~AimsApplication ()

Public Member Functions inherited from carto::CartoApplication
	CartoApplication (int argc, const char **argv, const std::string &documentation)

virtual	~CartoApplication ()

Public Member Functions inherited from carto::OptionsParser
	OptionsParser (int argc, const char **argv)

	~OptionsParser ()

void	addOption (T &param, const std::string &token, const std::string &description, bool optional=false)

void	addOptionSeries (T &param, const std::string &token, const std::string &description, unsigned minnum=0, unsigned maxnum=0)

void	alias (const std::string &to, const std::string &from)

void	parse ()

void	check ()

Static Public Member Functions
static std::string	versionString ()
	full version ("1.30.3" or "1.31beta") More...

static std::string	libraryVersionString ()
	shorter version matching the library number (2 numbers: "1.31") More...

Static Public Member Functions inherited from aims::AimsApplication
static AimsApplication *	globalApplication ()

Friends
class	::ReferentialWindow

class	anatomist::internal::AnatomistPrivate

Additional Inherited Members
Public Attributes inherited from aims::AimsApplication
int	output_4d_volumes

Protected Types inherited from carto::OptionsParser
typedef std::vector< OptionBase * >	OptionList

Protected Member Functions inherited from carto::OptionsParser
void	pushOption (OptionBase *)

Protected Attributes inherited from carto::OptionsParser
CommandLineArguments	cla

OptionList	options

int	insertIndex

Detailed Description

The Anatomist class holds information about all data handled by Anatomist: the objects, the windows, and other application-wide lists.

Althrough the Control and Referential Windows are one amongst the many Anatomist windows, they are in fact the image of the application, so they have a particular place in the Anatomist class.

Definition at line 71 of file Anatomist.h.

Member Enumeration Documentation

◆ Cursor

enum anatomist::Anatomist::Cursor

Enumerator
Normal
Working

Definition at line 75 of file Anatomist.h.

Constructor & Destructor Documentation

◆ Anatomist()

anatomist::Anatomist::Anatomist	(	int	argc,
		const char **	argv,
		const std::string &	documentation
	)

◆ ~Anatomist()

virtual anatomist::Anatomist::~Anatomist ( )

virtual

Member Function Documentation

◆ addObjectsFileFilter()

void anatomist::Anatomist::addObjectsFileFilter ( const std::string & filter )

◆ centralReferential()

Referential* anatomist::Anatomist::centralReferential ( ) const

◆ config()

GlobalConfiguration* anatomist::Anatomist::config ( )

◆ createControlWindow()

virtual void anatomist::Anatomist::createControlWindow ( )

virtual

◆ createReferentialWindow()

virtual void anatomist::Anatomist::createReferentialWindow ( )

virtual

Create the referential window and update it.

◆ destroying()

bool anatomist::Anatomist::destroying ( ) const

returns true if the Anatomist application is currently being destroyed

◆ destroyObject()

int anatomist::Anatomist::destroyObject	(	AObject *	,
		bool	verbose = `true`
	)

Destroys an object if possible.

\

Returns: true if the object has actually been deleted, \ false if the object cannot be deleted (it is used in other compound objects which require it and cannot release it)

◆ destroyObjects()

std::set<AObject *> anatomist::Anatomist::destroyObjects	(	const std::set< AObject * > &	,
		bool	verbose = `true`
	)

Destroys an object if possible.

\

Returns: objects which could not be destroyed

◆ getControlWindow()

ControlWindow* anatomist::Anatomist::getControlWindow ( ) const

◆ getObjects()

std::set<AObject* > anatomist::Anatomist::getObjects ( ) const

◆ getQWidgetAncestor()

QWidget* anatomist::Anatomist::getQWidgetAncestor ( ) const

Gets an empty QWidget that is created in Anatomist application to become a default parent for all Anatomist windows.

◆ getReferentials()

const std::set<Referential*>& anatomist::Anatomist::getReferentials ( ) const

◆ getReferentialWindow()

ReferentialWindow* anatomist::Anatomist::getReferentialWindow ( ) const

◆ getTransformation() [1/2]

Transformation* anatomist::Anatomist::getTransformation	(	const Referential *	,
		const Referential *
	)

◆ getTransformation() [2/2]

const Transformation* anatomist::Anatomist::getTransformation	(	const Referential *	,
		const Referential *
	)		const

◆ getWindows()

std::set<AWindow*> anatomist::Anatomist::getWindows ( ) const

◆ getWindowsInGroup()

std::set<AWindow*> anatomist::Anatomist::getWindowsInGroup ( int group )

Retruns the set of windows in a given group.

◆ glMakeCurrent()

virtual bool anatomist::Anatomist::glMakeCurrent ( )

virtual

◆ groupWindows()

int anatomist::Anatomist::groupWindows	(	std::set< AWindow * > &	winL,
		int	groupnum = `-1`
	)

Links the given windows, and returns the new group number.

◆ hasObject()

bool anatomist::Anatomist::hasObject ( const AObject * obj ) const

◆ hasReferential()

bool anatomist::Anatomist::hasReferential ( const Referential * )

◆ hasWindow()

bool anatomist::Anatomist::hasWindow ( const AWindow * win ) const

◆ historyWriter() [1/2]

CommandWriter& anatomist::Anatomist::historyWriter ( )

◆ historyWriter() [2/2]

const CommandWriter& anatomist::Anatomist::historyWriter ( ) const

◆ initialize()

virtual void anatomist::Anatomist::initialize ( )

virtual

Reimplemented from aims::AimsApplication.

◆ initialized()

bool anatomist::Anatomist::initialized ( ) const

◆ language()

std::string anatomist::Anatomist::language ( ) const

◆ lastFullPosition()

std::vector<float> anatomist::Anatomist::lastFullPosition ( const Referential * toref = 0 ) const

◆ lastPosition()

Point3df anatomist::Anatomist::lastPosition ( const Referential * toref = 0 ) const

◆ libraryVersionString()

static std::string anatomist::Anatomist::libraryVersionString ( )

static

shorter version matching the library number (2 numbers: "1.31")

◆ loadObject()

std::list<AObject *> anatomist::Anatomist::loadObject	(	const std::string &	filename,
		const std::string &	objname = `""`,
		carto::Object	options = `carto::none()`
	)

◆ lockObjects()

void anatomist::Anatomist::lockObjects ( bool locked = true )

lock / unlock the objects list mutex, used in threaded load operations

◆ makeObjectName()

std::string anatomist::Anatomist::makeObjectName ( const std::string & name )

Builds a unique object name.

◆ mapObject()

void anatomist::Anatomist::mapObject ( AObject * obj )

Makes an object visible (ie seen in control window(s))

◆ NotifyMapWindow()

void anatomist::Anatomist::NotifyMapWindow ( AWindow * )

◆ NotifyObjectChange()

void anatomist::Anatomist::NotifyObjectChange ( AObject * obj )

◆ NotifyUnmapWindow()

void anatomist::Anatomist::NotifyUnmapWindow ( AWindow * )

◆ NotifyWindowChange()

void anatomist::Anatomist::NotifyWindowChange ( AWindow * win )

◆ objectsFileFilter()

const std::string& anatomist::Anatomist::objectsFileFilter ( ) const

◆ palettes() [1/2]

PaletteList& anatomist::Anatomist::palettes ( )

◆ palettes() [2/2]

const PaletteList& anatomist::Anatomist::palettes ( ) const

◆ Refresh()

virtual void anatomist::Anatomist::Refresh ( )

virtual

◆ registerObject()

void anatomist::Anatomist::registerObject	(	AObject *	obj,
		int	inctrl = `1`
	)

◆ registerObjectName()

void anatomist::Anatomist::registerObjectName	(	const std::string &	name,
		AObject *	obj
	)

◆ registerReferential()

void anatomist::Anatomist::registerReferential ( Referential * ref )

◆ registerSubObject()

void anatomist::Anatomist::registerSubObject	(	MObject *	parent,
		AObject *	obj
	)

◆ registerWindow()

void anatomist::Anatomist::registerWindow ( AWindow * win )

◆ releaseObject()

void anatomist::Anatomist::releaseObject ( AObject * obj )

releases the reference counter kept in Anatomist application for the given object, so that external reference counting will behave normally.

If no external reference counter exists, the window will be immediately deleted.

◆ releaseWindow()

void anatomist::Anatomist::releaseWindow ( AWindow * win )

releases the reference counter kept in Anatomist application for the given window, so that external reference counting will behave normally.

If no external reference counter exists, the window will be immediately deleted.

◆ setCursor()

void anatomist::Anatomist::setCursor ( Cursor c )

Sets the shape of the mouse cursor on every window.

◆ setLastPosition() [1/2]

void anatomist::Anatomist::setLastPosition	(	const Point3df &	pos,
		Referential *	fromref = `0`
	)

◆ setLastPosition() [2/2]

void anatomist::Anatomist::setLastPosition	(	const std::vector< float > &	pos,
		Referential *	fromref = `0`
	)

◆ setUserLevel()

void anatomist::Anatomist::setUserLevel ( int )

◆ takeObjectRef()

void anatomist::Anatomist::takeObjectRef ( AObject * obj )

change object reference type to WeakShared (standard in anatomist)

◆ takeWindowRef()

void anatomist::Anatomist::takeWindowRef ( AWindow * obj )

change window reference type to WeakShared (standard in anatomist)

◆ ungroupWindows()

void anatomist::Anatomist::ungroupWindows ( int group )

Unlinks the windows with the given group number.

◆ unmapObject()

void anatomist::Anatomist::unmapObject ( AObject * obj )

Makes an object unvisible (ie not seen in control window(s))

◆ unregisterObject()

void anatomist::Anatomist::unregisterObject ( AObject * obj )

◆ unregisterObjectName()

void anatomist::Anatomist::unregisterObjectName ( const std::string & name )

◆ unregisterReferential()

void anatomist::Anatomist::unregisterReferential ( Referential * ref )

◆ unregisterWindow()

void anatomist::Anatomist::unregisterWindow ( AWindow * win )

◆ updateFileDialogObjectsFilter()

void anatomist::Anatomist::updateFileDialogObjectsFilter ( )

setup/update extensions list for readable files

◆ UpdateInterface()

virtual void anatomist::Anatomist::UpdateInterface ( )

virtual

◆ userLevel()

int anatomist::Anatomist::userLevel ( ) const

The user level drives the GUI to show or hide some features for simplicity or richness.

Values mean:

0: basic
1: advanced
2: expert
>=3: debugger with all unstable features enabled

◆ versionString()

static std::string anatomist::Anatomist::versionString ( )

static

full version ("1.30.3" or "1.31beta")

Friends And Related Function Documentation

◆ ::ReferentialWindow

friend class ::ReferentialWindow

friend

Definition at line 216 of file Anatomist.h.

◆ anatomist::internal::AnatomistPrivate

friend class anatomist::internal::AnatomistPrivate

friend

Definition at line 217 of file Anatomist.h.

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

anatomist/application/Anatomist.h

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Cursor

Constructor & Destructor Documentation

◆ Anatomist()

◆ ~Anatomist()

Member Function Documentation

◆ addObjectsFileFilter()

◆ centralReferential()

◆ config()

◆ createControlWindow()

◆ createReferentialWindow()

◆ destroying()

◆ destroyObject()

◆ destroyObjects()

◆ getControlWindow()

◆ getObjects()

◆ getQWidgetAncestor()

◆ getReferentials()

◆ getReferentialWindow()

◆ getTransformation() [1/2]

◆ getTransformation() [2/2]

◆ getWindows()

◆ getWindowsInGroup()

◆ glMakeCurrent()

◆ groupWindows()

◆ hasObject()

◆ hasReferential()

◆ hasWindow()

◆ historyWriter() [1/2]

◆ historyWriter() [2/2]

◆ initialize()

◆ initialized()

◆ language()

◆ lastFullPosition()

◆ lastPosition()

◆ libraryVersionString()

◆ loadObject()

◆ lockObjects()

◆ makeObjectName()

◆ mapObject()

◆ NotifyMapWindow()

◆ NotifyObjectChange()

◆ NotifyUnmapWindow()

◆ NotifyWindowChange()

◆ objectsFileFilter()

◆ palettes() [1/2]

◆ palettes() [2/2]

◆ Refresh()

◆ registerObject()

◆ registerObjectName()

◆ registerReferential()

◆ registerSubObject()

◆ registerWindow()

◆ releaseObject()

◆ releaseWindow()

◆ setCursor()

◆ setLastPosition() [1/2]

◆ setLastPosition() [2/2]

◆ setUserLevel()

◆ takeObjectRef()

◆ takeWindowRef()

◆ ungroupWindows()

◆ unmapObject()

◆ unregisterObject()

◆ unregisterObjectName()

◆ unregisterReferential()

◆ unregisterWindow()

◆ updateFileDialogObjectsFilter()

◆ UpdateInterface()

◆ userLevel()

◆ versionString()

Friends And Related Function Documentation

◆ ::ReferentialWindow

◆ anatomist::internal::AnatomistPrivate