visBase::Annotation Class Reference

Annotation is a simple wireframe box with text on its axis. More...

Inheritance diagram for visBase::Annotation:

Public Member Functions
	Annotation ()
void	allowShading (bool yn)
bool	canShowGridLines () const
void	fillPar (IOPar &) const
const Text2 *	getAnnotTexts () const
virtual const char *	getClassName () const
const visBase::Transformation *	getDisplayTransformation () const
const FontData &	getFont () const
const TrcKeyZSampling &	getScale () const
const TrcKeyZSampling &	getTrcKeyZSampling () const
bool	isGridLinesShown () const
bool	isScaleShown () const
bool	isTextShown () const
void	setDisplayTransformation (const visBase::Transformation *)
void	setFont (const FontData &)
virtual void	setPixelDensity (float)
void	setScale (const TrcKeyZSampling &)
void	setScaleFactor (int dim, int scale)
void	setScene (Scene *)
void	setText (int dim, const uiString &)
void	setTrcKeyZSampling (const TrcKeyZSampling &)
void	showGridLines (bool yn)
void	showScale (bool yn)
void	showText (bool yn)
bool	usePar (const IOPar &)
Public Member Functions inherited from visBase::VisualObjectImpl
Material *	getMaterial ()
const Material *	getMaterial () const
bool	isRightHandSystem () const
void	readLock ()
void	readUnLock ()
void	setLockable ()
void	setMaterial (Material *)
void	setRightHandSystem (bool yn)
bool	tryReadLock ()
bool	tryWriteLock ()
void	writeLock ()
void	writeUnLock ()
Public Member Functions inherited from visBase::VisualObject
NotifierAccess *	deSelection ()
virtual bool	getBoundingBox (Coord3 &min, Coord3 &max) const
virtual NotifierAccess *	rightClicked ()
const EventInfo *	rightClickedEventInfo () const
const TypeSet< int > *	rightClickedPath () const
bool	selectable () const
NotifierAccess *	selection ()
virtual void	setSceneEventCatcher (EventCatcher *)
void	setSelectable (bool yn)
Public Member Functions inherited from visBase::DataObject
template<class T >
T *	addNodeState (T *ns)
void	deSelect () const
void	enableTraversal (unsigned int mask, bool yn=true)
virtual const char *	errMsg () const
SoNode *	getInventorNode ()
const SoNode *	getInventorNode () const
virtual BufferString	getName () const
NodeState *	getNodeState (int idx)
virtual float	getPixelDensity () const
int	id () const
virtual bool	isOK () const
virtual bool	isOn () const
bool	isPickable (bool actively=true) const
virtual bool	isSelected () const
bool	isTraversalEnabled (unsigned int mask) const
virtual const OD::String &	name () const
osg::Node *	osgNode (bool skipswitch=false)
const osg::Node *	osgNode (bool skipswitch=false) const
NodeState *	removeNodeState (NodeState *)
virtual bool	rightClickable () const
void	select () const
bool	serialize (const char *filename, bool binary=false)
void	setID (int nid)
virtual void	setName (const char *)
void	setName (const uiString &uistr)
void	setParent (DataObjectGroup *g)
void	setPickable (bool actively, bool passively=true)
void	setUiName (const uiString &)
virtual bool	turnOn (bool yn)
uiString	uiName () const
void	updateSel () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
bool	operator== (const NamedCallBacker &oth) const
bool	operator== (const NamedObject &oth) const
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
void	stopReceivingNotifications () const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
bool	getNameFromPar (const IOPar &)
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()
bool	hasName (const char *nm) const
bool	hasName (const name_type &nm) const
void	putNameInPar (IOPar &) const

Static Public Member Functions
static Annotation *	create ()
static const char *	getStaticClassName ()
static void	initClass ()
static const char *	sFactoryKeyword ()
Static Public Member Functions inherited from visBase::VisualObjectImpl
static const char *	sKeyIsOn ()
static const char *	sKeyMaterial ()
static const char *	sKeyMaterialID ()
Static Public Member Functions inherited from visBase::DataObject
static osgViewer::CompositeViewer *	getCommonViewer ()
static float	getDefaultPixelDensity ()
static int	getID (const osg::Node *)
static bool	isVisualizationThread ()
static void	requestSingleRedraw ()
static void	setCommonViewer (osgViewer::CompositeViewer *)
static void	setDefaultPixelDensity (float)
static void	setVisualizationThread (const void *)
	Call only once from initialization. More...
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Private Member Functions
	Annotation (const Annotation &)
	~Annotation ()
void	firstTraversal (CallBacker *)
void	getAxisCoords (int, osg::Vec3f &, osg::Vec3f &) const
void	initGridLines ()
Annotation &	operator= (const Annotation &)
void	setCorner (int, float, float, float)
void	updateGridLines ()
void	updateTextColor (CallBacker *)
void	updateTextPos ()

Static Private Member Functions
static const char *	cornerprefixstr ()
static visBase::DataObject *	createInternal ()
static const char *	showscalestr ()
static const char *	showtextstr ()
static const char *	textprefixstr ()

Private Attributes
bool	allowshading_
Color	annotcolor_
RefMan< Text2 >	axisannot_
RefMan< Text2 >	axisnames_
osg::Geometry *	box_
const visBase::Transformation *	displaytrans_
osg::Geode *	geode_
osg::Array *	gridlinecoords_
osgGeo::OneSideRender *	gridlines_
TrcKeyZSampling	scale_
int	scalefactor_ [3]
visBase::Scene *	scene_
TrcKeyZSampling	tkzs_
TrcKeyZSampling	tkzsdefaultscale_

Additional Inherited Members
Public Types inherited from ObjectWithName
typedef OD::String	name_type
Protected Member Functions inherited from visBase::VisualObjectImpl
	VisualObjectImpl (bool selectable)
virtual	~VisualObjectImpl ()
int	addChild (osg::Node *)
int	childIndex (const osg::Node *) const
void	insertChild (int pos, osg::Node *)
virtual void	materialChangeCB (CallBacker *)
void	removeChild (osg::Node *)
void	setGroupNode (DataObject *)
virtual void	setGroupNode (osg::Group *)
	Must be called during construction. More...
Protected Member Functions inherited from visBase::VisualObject
	VisualObject (bool selectable=false)
	~VisualObject ()
void	triggerDeSel ()
void	triggerRightClick (const EventInfo *)
void	triggerSel ()
Protected Member Functions inherited from visBase::DataObject
	DataObject ()
void	doAddNodeState (NodeState *ns)
virtual osg::StateSet *	getStateSet ()
template<class T >
T *	setOsgNode (T *t)
	Must be called during construction. More...
void	updateNodemask ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const
Protected Attributes inherited from visBase::VisualObjectImpl
Material *	material_
bool	righthandsystem_
Protected Attributes inherited from visBase::DataObject
DataObjectGroup *	parent_
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

Annotation is a simple wireframe box with text on its axis.

<>

Constructor & Destructor Documentation

Annotation() [1/2]

visBase::Annotation::Annotation ( const Annotation &  )

private

Annotation() [2/2]

visBase::Annotation::Annotation

(

)

~Annotation()

visBase::Annotation::~Annotation ( )

private

Member Function Documentation

allowShading()

void visBase::Annotation::allowShading ( bool  yn )

inline

canShowGridLines()

bool visBase::Annotation::canShowGridLines

(

)

const

cornerprefixstr()

static const char* visBase::Annotation::cornerprefixstr ( )

staticprivate

create()

static Annotation* visBase::Annotation::create ( )

inlinestatic

createInternal()

static visBase::DataObject* visBase::Annotation::createInternal ( )

inlinestaticprivate

fillPar()

void visBase::Annotation::fillPar ( IOPar &  ) const

virtual

Reimplemented from visBase::VisualObjectImpl.

firstTraversal()

void visBase::Annotation::firstTraversal ( CallBacker *  )

private

getAnnotTexts()

const Text2* visBase::Annotation::getAnnotTexts ( ) const

inline

getAxisCoords()

void visBase::Annotation::getAxisCoords ( int  , osg::Vec3f &  , osg::Vec3f &    ) const

private

getClassName()

virtual const char* visBase::Annotation::getClassName ( ) const

virtual

Reimplemented from visBase::DataObject.

getDisplayTransformation()

const visBase::Transformation* visBase::Annotation::getDisplayTransformation ( ) const

inlinevirtual

All positions going from the outside world to the vis should be transformed with this transform. This enables us to have different coord-systems outside OI, e.g. we can use UTM coords outside the vis without loosing precision in the vis.

Reimplemented from visBase::DataObject.

getFont()

const FontData& visBase::Annotation::getFont

(

)

const

getScale()

const TrcKeyZSampling& visBase::Annotation::getScale

(

)

const

getStaticClassName()

static const char* visBase::Annotation::getStaticClassName ( )

static

getTrcKeyZSampling()

const TrcKeyZSampling& visBase::Annotation::getTrcKeyZSampling

(

)

const

initClass()

static void visBase::Annotation::initClass ( )

static

initGridLines()

void visBase::Annotation::initGridLines ( )

private

isGridLinesShown()

bool visBase::Annotation::isGridLinesShown

(

)

const

isScaleShown()

bool visBase::Annotation::isScaleShown

(

)

const

isTextShown()

bool visBase::Annotation::isTextShown

(

)

const

operator=()

Annotation& visBase::Annotation::operator= ( const Annotation &  )

private

setCorner()

void visBase::Annotation::setCorner ( int  , float  , float  , float    )

private

setDisplayTransformation()

void visBase::Annotation::setDisplayTransformation ( const visBase::Transformation *  )

virtual

All positions going from the outside world to the vis should be transformed with this transform. This enables us to have different coord-systems outside OI, e.g. we can use UTM coords outside the vis without loosing precision in the vis.

Reimplemented from visBase::DataObject.

setFont()

void visBase::Annotation::setFont

(

const FontData &

)

setPixelDensity()

virtual void visBase::Annotation::setPixelDensity ( float  )

virtual

Reimplemented from visBase::DataObject.

setScale()

void visBase::Annotation::setScale

(

const TrcKeyZSampling &

)

setScaleFactor()

void visBase::Annotation::setScaleFactor	(	int	dim,
		int	scale
	)

setScene()

void visBase::Annotation::setScene

(

Scene *

)

setText()

void visBase::Annotation::setText	(	int	dim,
		const uiString &
	)

setTrcKeyZSampling()

void visBase::Annotation::setTrcKeyZSampling

(

const TrcKeyZSampling &

)

sFactoryKeyword()

static const char* visBase::Annotation::sFactoryKeyword ( )

static

showGridLines()

void visBase::Annotation::showGridLines

(

bool

yn

)

showScale()

void visBase::Annotation::showScale

(

bool

yn

)

showscalestr()

static const char* visBase::Annotation::showscalestr ( )

staticprivate

showText()

void visBase::Annotation::showText

(

bool

yn

)

showtextstr()

static const char* visBase::Annotation::showtextstr ( )

staticprivate

textprefixstr()

static const char* visBase::Annotation::textprefixstr ( )

staticprivate

updateGridLines()

void visBase::Annotation::updateGridLines ( )

private

updateTextColor()

void visBase::Annotation::updateTextColor ( CallBacker *  )

private

updateTextPos()

void visBase::Annotation::updateTextPos ( )

private

usePar()

bool visBase::Annotation::usePar ( const IOPar &  )

virtual

Reimplemented from visBase::VisualObjectImpl.

Member Data Documentation

allowshading_

bool visBase::Annotation::allowshading_

private

annotcolor_

Color visBase::Annotation::annotcolor_

private

axisannot_

RefMan<Text2> visBase::Annotation::axisannot_

private

axisnames_

RefMan<Text2> visBase::Annotation::axisnames_

private

box_

osg::Geometry* visBase::Annotation::box_

private

displaytrans_

const visBase::Transformation* visBase::Annotation::displaytrans_

private

geode_

osg::Geode* visBase::Annotation::geode_

private

gridlinecoords_

osg::Array* visBase::Annotation::gridlinecoords_

private

gridlines_

osgGeo::OneSideRender* visBase::Annotation::gridlines_

private

scale_

TrcKeyZSampling visBase::Annotation::scale_

private

scalefactor_

int visBase::Annotation::scalefactor_[3]

private

scene_

visBase::Scene* visBase::Annotation::scene_

private

tkzs_

TrcKeyZSampling visBase::Annotation::tkzs_

private

tkzsdefaultscale_

TrcKeyZSampling visBase::Annotation::tkzsdefaultscale_

private