Nomenclature hierarchy object. More...

#include <anatomist/hierarchy/hierarchy.h>

Inheritance diagram for anatomist::Hierarchy:

[legend]

Collaboration diagram for anatomist::Hierarchy:

[legend]

Public Member Functions
	Hierarchy (Tree *tr)

	Hierarchy (carto::rc_ptr< Tree > tr)

virtual	~Hierarchy ()

carto::rc_ptr< Tree >	tree ()

virtual bool	Is2DObject ()
	not a 2D object More...

virtual bool	Is3DObject ()
	... neither a 3D... More...

virtual Tree *	optionTree () const
	Menu tree for new options, see object/optionMatcher.h. More...

virtual carto::GenericObject *	attributed ()

virtual bool	save (const std::string &filename)

virtual void	internalUpdate ()
	Updates the state of the object. More...

Tree *	findNamedNode (const std::string &name, const std::list< Tree > *parents=0) const

Public Member Functions inherited from anatomist::AObject
	AObject (const std::string &filename="")

virtual	~AObject ()
	AObject subclasses must call cleanup() in their destructor. More...

virtual AObject *	clone (bool shallow=true)
	Makes a copy of the object, with a duplicated object structure, palette and material, but which may share the underlying low-level data object (Aims object). More...

virtual const GLComponent *	glAPI () const
	OpenGL objects const API. More...

virtual GLComponent *	glAPI ()
	OpenGL objects API. More...

virtual const MObject *	mObjectAPI () const

virtual MObject *	mObjectAPI ()

int	type () const
	Object type identifier. More...

void	setType (int type)
	Method to set type id, because type() is not virtual. More...

int	id () const
	Unique ID assigned upon construction, but somewhat unused now... More...

std::string	name () const
	Name shown in control window. More...

std::string	fileName () const
	File name (if any) for loaded objects. More...

void	setName (const std::string &n)

void	setFileName (const std::string &filename)

void	setId (int id)

virtual int	isMultiObject () const
	maybe not necessary ?: we can use dynamic_cast instead More...

virtual float	MinT () const
	Obsolete, deprecated. More...

virtual float	MaxT () const
	Obsolete, deprecated. More...

virtual bool	boundingBox2D (std::vector< float > &bmin, std::vector< float > &bmax) const
	Bounding box in 2D views mode. More...

virtual bool	boundingBox (std::vector< float > &bmin, std::vector< float > &bmax) const
	Fills bmin and bmax with the N-D bounding box extrema in the object's referential coordinates. More...

virtual bool	render (PrimList &, const ViewState &)
	rendering (generally 2D or 3D using OpenGL). More...

virtual std::vector< float >	voxelSize () const
	Returns at least 4 sizes. For 3D objects, returns (1, 1, 1, 1) More...

virtual void	setVoxelSize (const std::vector< float > &)

virtual void	adjustPalette ()
	Creates or updates object palette according to object values (if needed) More...

virtual AObjectPalette *	palette ()
	Normally, getOrCreatePalette() should be used instead of this function in most cases. More...

virtual const AObjectPalette *	palette () const

virtual void	setPalette (const AObjectPalette &palette)

virtual const AObjectPalette *	getOrCreatePalette () const
	User normally calls this function. More...

virtual void	createDefaultPalette (const std::string &name="")
	function called by getOrCreatePalette() - overloadable, need not be called directly More...

virtual void	SetMaterial (const Material &mat)

virtual Material &	GetMaterial ()

virtual const Material &	material () const

Referential *	getReferential () const

AObject *	referentialInheritance () const
	if not null, the object referential is inherited from this object More...

virtual void	setReferentialInheritance (AObject *ao)

virtual void	setReferential (Referential *ref)

virtual AObject *	fallbackReferentialInheritance () const
	object to take referential from when no ref is assigned More...

const Referential *	previousReferential () const
	Referential that the object was in before the last change. More...

virtual ObjectMenu *	optionMenu () const

int	InMemory () const
	For objects loading only when needed (not used yet...) More...

int	Visible () const
	Visibility in control window. More...

void	SetVisibility (int v)

ParentList &	Parents ()
	List of multi-objects containing this one. Obsolete: use parents() More...

ParentList &	parents ()
	List of multi-objects containing this one. More...

const ParentList &	parents () const
	List of multi-objects containing this one. More...

virtual void	RegisterParent (MObject *pob)

virtual void	UnregisterParent (MObject *pob)

const std::set< AWindow * > &	WinList ()
	List of windows showing this object. More...

virtual void	registerWindow (AWindow *window)

virtual void	unregisterWindow (AWindow *window)

virtual bool	textured2D () const
	true if 2D rendering uses a textured plane (not a full openGL object) More...

virtual bool	isTransparent () const

virtual bool	renderingIsObserverDependent () const
	true only if the rendering (openGL) of the object changes with the observer position/orientation of the view (which is rare, but typically needed for Volume Rendering) More...

virtual int	CanBeDestroyed ()
	Allows / unallows destruction of object. More...

virtual void	setReferenceChanged ()

bool	hasReferenceChanged () const

virtual void	setInternalsChanged ()
	Notifies some underlying lower-level objects have changed. More...

virtual void	clearHasChangedFlags () const
	Reset has-changed flags. More...

virtual AObject *	objectAt (const std::vector< float > &pos, float tol=0)
	Find the object (sub-object) at given postion with a tolerence. More...

virtual AObject *	objectAt (const std::vector< float > &pos, float tol, const Referential *orgref, const Point3df &orggeom)
	Same with origin window referential. More...

virtual void	setGeomExtrema ()
	Scans the object internals and determines its geometry extrema. More...

virtual void	SetExtrema ()
	Scans the object internals and determines its (texture) extrema values. More...

virtual bool	hasTexture () const
	Textured objects have values associated with a geometric coordinate. More...

virtual unsigned	dimTexture () const
	Number of texture values for a point. More...

virtual float	mixedTexValue (const std::vector< float > &pos, const Referential *orgRef) const
	Gets a "mixed" texture value at a given space / time location. More...

virtual float	mixedTexValue (const std::vector< float > &pos) const
	Same as above except that coordinates are not transformed but taken in object coordinates system. More...

virtual std::vector< float >	texValues (const std::vector< float > &pos, const Referential *orgRef) const
	Gets the array of texture values at a given location. More...

virtual std::vector< float >	texValues (const std::vector< float > &pos) const

virtual bool	loadable () const

virtual bool	savable () const

virtual bool	reload (const std::string &filename)
	Re-reads objects from disk. More...

virtual std::string	objectFullTypeName (void) const
	Get Object Full Type Name. More...

virtual bool	printTalairachCoord (const Point3df &, const Referential *) const
	should be replaced by a real referential More...

void	setHeaderOptions ()
	Set some object properties according to the header (.minf), such as material, palette etc. More...

virtual void	setProperties (carto::Object options)
	Same as setHeaderOptions() and used by it, allows passing a dictionary. More...

virtual void	storeHeaderOptions ()
	Store some object properties into the header (.minf), such as material, palette etc before saving the object. More...

virtual carto::Object	makeHeaderOptions () const
	get object properties into a generic object, such as material, palette etc before saving the object More...

long	loadDate () const
	Time the object was created, loaded or reloaded. More...

void	setLoadDate (long t)

virtual void	update (const Observable observable, void arg)
	This method is called whenever the observed object is changed. More...

bool	isCopy () const

void	setCopyFlag (bool x=true)

virtual std::string	toolTip () const
	tooltip displayed in 3D views (HTML). More...

carto::Object	aimsMeshFromGLComponent ()

Public Member Functions inherited from anatomist::Observable
	Observable ()
	Construct an Observable with zero observers. More...

virtual	~Observable ()
	does nothing More...

void	addObserver (Observer *observer)
	Adds an observer to the set of observers for this object. More...

void	deleteObserver (Observer *observer)
	Deletes an observer from the set of observers of this object. More...

void	deleteObservers ()
	Clears the observer list so that this object no longer has any observers (doesn't call any observer method - see notifyUnregisterObservers() for this ) More...

int	countObservers () const
	Returns the number of observers of this object. More...

virtual void	notifyObservers (void *arg=0)
	If this object has changed, as indicated by the hasChanged method, then notify all of its observers. More...

virtual void	notifyUnregisterObservers ()
	Notifies observable destruction to all observers and unregisters them. More...

bool	hasChanged () const
	Tests if this object has changed. More...

bool	obsHasChanged (int) const
	only valid during an Observer::update() More...

bool	obsHasChanged (const std::string &) const
	only valid during an Observer::update() More...

void	setChanged () const
	Indicates that this object has changed. More...

Public Member Functions inherited from carto::SharedObject
	SharedObject ()

	SharedObject (const SharedObject &x)

virtual	~SharedObject ()

SharedObject &	operator= (const SharedObject &)

bool	testDeletable ()

bool	tryDelete ()

Public Member Functions inherited from carto::WeakObject
void	attachWeakPtr (weak_ptr< T > &) const

void	detachWeakPtr (weak_ptr< T > &) const

void	attachWeakPtr (weak_shared_ptr< T > &) const

void	detachWeakPtr (weak_shared_ptr< T > &) const

virtual	~WeakObject ()

Public Member Functions inherited from carto::RCObject
	RCObject ()

	RCObject (const RCObject &)

RCObject &	operator= (const RCObject &)

virtual	~RCObject ()

Public Member Functions inherited from anatomist::Observer
virtual	~Observer ()

Public Member Functions inherited from anatomist::PythonAObject
	PythonAObject ()

virtual	~PythonAObject ()

virtual const carto::GenericObject *	attributed () const

Static Public Member Functions
static std::list< AObject * >	loadHierarchy (const std::string &filename, std::vector< std::pair< AObject *, bool > > &, carto::Object options)

static int	classType ()

static void	namesUnder (Tree *tr, std::set< std::string > &names)

static Hierarchy *	findMatchingNomenclature (const AObject obj, const AGraph *ag=0)
	finds a Hierarchy matching for edition of the given object (which should be a graph or graph element) More...

Static Public Member Functions inherited from anatomist::AObject
static std::list< AObject * >	load (const std::string &filename)
	Static object loader: creates an objects, loads its contents. More...

static bool	reload (AObject *object, bool onlyoutdated=false)
	Reads from disk again. More...

static int	registerObjectType (const std::string &id)
	Creates a new object type number and returns it. More...

static std::string	objectTypeName (int type)

static void	setObjectMenu (std::string type, carto::rc_ptr< ObjectMenu > om)

static carto::rc_ptr< ObjectMenu >	getObjectMenu (std::string type)

static std::map< std::string, carto::rc_ptr< ObjectMenu > > &	getObjectMenuMap ()

static void	addObjectMenuRegistration (ObjectMenuRegistrerFunction)

static void	addObjectMenuRegistration (ObjectMenuRegistrerClass *)

static void	cleanStatic ()
	cleanup static global variables (called when quitting anatomist) More...

Protected Attributes
carto::rc_ptr< Tree >	_tree

Protected Attributes inherited from anatomist::AObject
int	_type
	Should be static in each object class. More...

int	_id

std::string	_name

std::string	_filename

std::set< AWindow * >	_winList

int	_inMemory

int	_visible

ParentList	_parents

Material	_material
	Should be a pointer: some objects don't have a material (2D objects) More...

Referential *	_referential
	Referentiel. More...

bool	_referenceHasChanged
	Reference has-changed flag. More...

AObjectPalette *	_palette
	Palette. More...

Static Protected Attributes
static Tree *	_optionTree

Static Protected Attributes inherited from anatomist::AObject
static std::map< std::string, int >	_objectTypes
	name-to-type map More...

static std::map< int, std::string >	_objectTypeNames
	type-to-name map More...

static std::map< std::string, carto::rc_ptr< ObjectMenu > >	_objectmenu_map
	Object Menu Map. More...

Additional Inherited Members
Public Types inherited from anatomist::AObject
enum	ObjectType { VOLUME, BUCKET, FACET, TRIANG, LIST, VECTOR, MAP, SET, GRAPH, GRAPHOBJECT, VOLSURF, MULTISURF, MULTIBUCKET, MULTIVOLUME, FUSION2D, FUSION3D, FASCICLE, FASCICLEGRAPH, TEXTURE, TEXSURFACE, FUSION2DMESH, VECTORFIELD, OTHER }
	Base object type identifiers. More...

typedef std::set< MObject * >	ParentList
	Storage type for parent objects (multi-objects containing this one) More...

typedef ObjectMenu (	ObjectMenuRegistrerFunction) (const AObject objtype, ObjectMenu menu)
	dynamic menu registration function More...

Public Types inherited from carto::RCObject
typedef int	RefCounterType

Protected Member Functions inherited from anatomist::AObject
const PrimList &	primitives () const

PrimList &	primitives ()

virtual void	cleanup ()
	must be called by objects destructors - Must be explicitly called by each object destructor since it can call virtual functions More...

virtual void	clearReferentialInheritance ()
	sets the object to get referential from to null, unregister it More...

AObject *&	_referentialInheritance ()
	provide access to derived classes More...

virtual void	unregisterObservable (Observable *)
	Called when an observable is destroyed, only called by Observable: don't use this function directly. More...

	AObject (const AObject &)
	copy constructor, protected and used only to reimplement clone() More...

Protected Member Functions inherited from anatomist::Observable
void	clearChanged () const
	Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change. More...

void	obsSetChanged (int, bool=true) const
	int-based change flags (use enums to address them) More...

void	obsSetChanged (const std::string &, bool=true) const
	string-based change flags More...

Protected Member Functions inherited from carto::SharedObject
void	disableRefCount ()

Protected Member Functions inherited from carto::WeakObject
	WeakObject ()

	WeakObject (const WeakObject &)

WeakObject &	operator= (const WeakObject &)

Protected Member Functions inherited from anatomist::Observer
virtual void	cleanupObserver ()
	call this function from inherited classes destructors. More...

virtual void	registerObservable (Observable *)
	only called by Observable: don't use this function directly More...

const std::set< Observable * > &	observed () const

Detailed Description

Nomenclature hierarchy object.

Definition at line 51 of file hierarchy.h.

Constructor & Destructor Documentation

◆ Hierarchy() [1/2]

anatomist::Hierarchy::Hierarchy ( Tree * tr )

◆ Hierarchy() [2/2]

anatomist::Hierarchy::Hierarchy ( carto::rc_ptr< Tree > tr )

◆ ~Hierarchy()

virtual anatomist::Hierarchy::~Hierarchy ( )

virtual

Member Function Documentation

◆ attributed()

virtual carto::GenericObject* anatomist::Hierarchy::attributed ( )

virtual

Implements anatomist::PythonAObject.

Referenced by classType().

◆ classType()

static int anatomist::Hierarchy::classType ( )

inlinestatic

Definition at line 68 of file hierarchy.h.

References attributed(), findMatchingNomenclature(), findNamedNode(), internalUpdate(), anatomist::AObject::name(), namesUnder(), optionTree(), anatomist::AObject::parents(), and save().

◆ findMatchingNomenclature()

static Hierarchy* anatomist::Hierarchy::findMatchingNomenclature	(	const AObject *	obj,
		const AGraph **	ag = `0`
	)

static

finds a Hierarchy matching for edition of the given object (which should be a graph or graph element)

Parameters

ag	if not null, will be set to the parent graph of obj

Referenced by classType().

◆ findNamedNode()

Tree* anatomist::Hierarchy::findNamedNode	(	const std::string &	name,
		const std::list< Tree > *	parents = `0`
	)		const

Referenced by classType().

◆ internalUpdate()

virtual void anatomist::Hierarchy::internalUpdate ( )

virtual

Updates the state of the object.

(when a part has changed and other parts depend on this change). Does nothing by default

Reimplemented from anatomist::AObject.

Referenced by classType().

◆ Is2DObject()

virtual bool anatomist::Hierarchy::Is2DObject ( )

inlinevirtual

not a 2D object

Implements anatomist::AObject.

Definition at line 65 of file hierarchy.h.

◆ Is3DObject()

virtual bool anatomist::Hierarchy::Is3DObject ( )

inlinevirtual

... neither a 3D...

Implements anatomist::AObject.

Definition at line 67 of file hierarchy.h.

◆ loadHierarchy()

static std::list<AObject*> anatomist::Hierarchy::loadHierarchy	(	const std::string &	filename,
		std::vector< std::pair< AObject *, bool > > &	,
		carto::Object	options
	)

static

Referenced by tree().

◆ namesUnder()

static void anatomist::Hierarchy::namesUnder	(	Tree *	tr,
		std::set< std::string > &	names
	)

static

Referenced by classType().

◆ optionTree()

virtual Tree* anatomist::Hierarchy::optionTree ( ) const

virtual

Menu tree for new options, see object/optionMatcher.h.

Reimplemented from anatomist::AObject.

Referenced by classType().

◆ save()

virtual bool anatomist::Hierarchy::save ( const std::string & filename )

virtual

Reimplemented from anatomist::AObject.

Referenced by classType().

◆ tree()

carto::rc_ptr<Tree> anatomist::Hierarchy::tree ( )

inline

Definition at line 58 of file hierarchy.h.

References _tree, and loadHierarchy().

Member Data Documentation

◆ _optionTree

Tree* anatomist::Hierarchy::_optionTree

staticprotected

Definition at line 88 of file hierarchy.h.

◆ _tree

carto::rc_ptr<Tree> anatomist::Hierarchy::_tree

protected

Definition at line 87 of file hierarchy.h.

Referenced by tree().

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

anatomist/hierarchy/hierarchy.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Hierarchy() [1/2]

◆ Hierarchy() [2/2]

◆ ~Hierarchy()

Member Function Documentation

◆ attributed()

◆ classType()

◆ findMatchingNomenclature()

◆ findNamedNode()

◆ internalUpdate()

◆ Is2DObject()

◆ Is3DObject()

◆ loadHierarchy()

◆ namesUnder()

◆ optionTree()

◆ save()

◆ tree()

Member Data Documentation

◆ _optionTree

◆ _tree