FlatView::AuxData Class Reference

Class that represents non-bitmap data to be displayed in a flatviewer, such as markers, lines and more. More...

Inheritance diagram for FlatView::AuxData:

Classes
class	EditPermissions
	Explains what part of an AuxData's appearance may be edited by the user. More...
class	FillGradient

Public Types
enum	NamePos { First =-1 , Center =0 , Last =1 , NoDraw }

Public Member Functions
virtual	~AuxData ()
virtual AuxData *	clone () const
void	empty ()
bool	isEmpty () const
void	setFillPattern (const FillPattern &fp)
virtual void	touch ()

Public Attributes
bool	close_ = false
MouseCursor	cursor_
EditPermissions *	editpermissions_ = nullptr
	If null no editing allowed. More...
bool	enabled_ = true
	Turns on/off everything. More...
OD::Color	fillcolor_ = OD::Color::NoColor()
FillGradient	fillgradient_
FillPattern	fillpattern_
bool	fitnameinview_ = true
OD::LineStyle	linestyle_
TypeSet< MarkerStyle2D >	markerstyles_
BufferString	name_
Alignment	namealignment_ = Alignment(Alignment:: Center ,Alignment:: Center )
NamePos	namepos_ = NoDraw
bool	needsupdatelines_ = true
TypeSet< Point >	poly_
bool	turnon_ = true
Interval< double > *	x1rg_ = nullptr
Interval< double > *	x2rg_ = nullptr
	if null, use viewer's rg & zoom More...
int	zvalue_ = 1
	overlay zvalue ( max=on top ) More...

Protected Member Functions
	AuxData (const AuxData &)
	AuxData (const char *nm)

Friends
class	Viewer

Detailed Description

Class that represents non-bitmap data to be displayed in a flatviewer, such as markers, lines and more.

<>

Member Enumeration Documentation

NamePos

enum FlatView::AuxData::NamePos

Enumerator
First
Center
Last
NoDraw

Constructor & Destructor Documentation

~AuxData()

virtual FlatView::AuxData::~AuxData ( )

virtual

AuxData() [1/2]

FlatView::AuxData::AuxData ( const char *  nm )

protected

AuxData() [2/2]

FlatView::AuxData::AuxData ( const AuxData &  )

protected

Member Function Documentation

clone()

virtual AuxData* FlatView::AuxData::clone ( ) const

inlinevirtual

Reimplemented in FlatView::uiAuxDataDisplay.

empty()

void FlatView::AuxData::empty

(

)

isEmpty()

bool FlatView::AuxData::isEmpty

(

)

const

setFillPattern()

void FlatView::AuxData::setFillPattern ( const FillPattern &  fp )

inline

touch()

virtual void FlatView::AuxData::touch ( )

inlinevirtual

Reimplemented in FlatView::uiAuxDataDisplay.

Friends And Related Function Documentation

Viewer

friend class Viewer

friend

Member Data Documentation

close_

bool FlatView::AuxData::close_ = false

cursor_

MouseCursor FlatView::AuxData::cursor_

editpermissions_

EditPermissions* FlatView::AuxData::editpermissions_ = nullptr

If null no editing allowed.

enabled_

bool FlatView::AuxData::enabled_ = true

Turns on/off everything.

fillcolor_

OD::Color FlatView::AuxData::fillcolor_ = OD::Color::NoColor()

fillgradient_

FillGradient FlatView::AuxData::fillgradient_

fillpattern_

FillPattern FlatView::AuxData::fillpattern_

fitnameinview_

bool FlatView::AuxData::fitnameinview_ = true

linestyle_

OD::LineStyle FlatView::AuxData::linestyle_

markerstyles_

TypeSet<MarkerStyle2D> FlatView::AuxData::markerstyles_

• No markerstyles means no markers will be displayed.
• If number of markerstyles is more than zero, but less than number of points, the last markerstyle will be used for the excess points.

name_

BufferString FlatView::AuxData::name_

namealignment_

Alignment FlatView::AuxData::namealignment_ = Alignment(Alignment:: Center ,Alignment:: Center )

namepos_

NamePos FlatView::AuxData::namepos_ = NoDraw

needsupdatelines_

bool FlatView::AuxData::needsupdatelines_ = true

poly_

TypeSet<Point> FlatView::AuxData::poly_

turnon_

bool FlatView::AuxData::turnon_ = true

x1rg_

Interval<double>* FlatView::AuxData::x1rg_ = nullptr

x2rg_

Interval<double>* FlatView::AuxData::x2rg_ = nullptr

if null, use viewer's rg & zoom

zvalue_

int FlatView::AuxData::zvalue_ = 1

overlay zvalue ( max=on top )