makVrv::DtChannelGridLines Class Reference

A model-like object that draws grid lines on a channel. More...

Inheritance diagram for makVrv::DtChannelGridLines:

Public Member Functions
	DtChannelGridLines (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtChannelGridLines ()
	DTOR.
virtual void	setInstance (DtChannelGridLinesInstance *instance)
	Set or replace the gridLines instance for the gridLines Transfers ownership.
virtual DtChannelGridLinesInstance *	instance ()
	Get the gridLines instance for the gridLines.
virtual void	setVisible (bool isVisible)
	Set the gridLines' visibility.
void	setChannelName (const std::string &deName, const std::string &winName, const std::string &channelName)
	Set the name of the channel that these gridLines should be drawn on.
void	setModelDefinition (const std::string &modelDefinition)
	Set the model definition; note that this (potentially) includes all the other parameters enumeration below.
void	setGridType (unsigned gridType)
	Set the grid type.
void	setUnitType (unsigned unitType, bool isAngular)
	Set the unit type.
void	setAutoSpacing (bool autoSpacing)
	Set whether auto spacing is used.
void	setFixedSpacingAmount (double amount)
	Set the fixed spacing amount.
void	setMinSpacing (int pixels)
	Set the minimum pixel spacing for auto spacing.
void	setXOffset (double offset)
	Set the x offset for the origin.
void	setYOffset (double offset)
	Set the y offset for the origin.
void	setDecimalPlaces (unsigned decimalPlaces)
	Set the decimalPlaces to use.
virtual void	setMaxGridLines (int maxGridLines)
	The remaining parameters are normally set through the model definition If you call any of these functions BEFORE the model definition is set, and that parameter is in the model definition, it will override the value set by the mutator.
virtual void	setEastWestGridLineColor (float r, float g, float b, float a)
	Set the color of east-west grid lines.
virtual void	setEastWestLabelColor (float r, float g, float b, float a)
	Set the color of the labels on east-west grid lines.
virtual void	setNorthSouthGridLineColor (float r, float g, float b, float a)
	Set the color of north-south grid lines.
virtual void	setNorthSouthLabelColor (float r, float g, float b, float a)
	Set the color of the labels north-south grid lines.
virtual void	setLabelFont (const std::string &fontName)
	Set the font used for labels.
virtual void	setLabelPointSize (int pointSize)
	Set the point size used for labels.
virtual void	setLabelXOffset (int pixels)
	Set the offset of labels from the bottom of the screen.
virtual void	setLabelYOffset (int pixels)
	Set the offset of labels from the left side of the screen.
virtual void	setLabelTextWidth (int width)
	Set the width of the box used to display text in.
virtual void	setLabelTextHeight (int height)
	Set the height of the box used to display text in.
virtual void	setGridLineWidth (float width)
	Set the width of grid lines.

Protected Attributes
DtChannelGridLinesInstance *	myInstance

Detailed Description

A model-like object that draws grid lines on a channel.

Constructor & Destructor Documentation

makVrv::DtChannelGridLines::DtChannelGridLines	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtChannelGridLines::~DtChannelGridLines ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtChannelGridLines::setInstance ( DtChannelGridLinesInstance *  instance )

virtual

Set or replace the gridLines instance for the gridLines Transfers ownership.

virtual DtChannelGridLinesInstance* makVrv::DtChannelGridLines::instance ( )

virtual

Get the gridLines instance for the gridLines.

virtual void makVrv::DtChannelGridLines::setVisible ( bool  isVisible )

virtual

Set the gridLines' visibility.

void makVrv::DtChannelGridLines::setChannelName	(	const std::string &	deName,
		const std::string &	winName,
		const std::string &	channelName
	)

Set the name of the channel that these gridLines should be drawn on.

void makVrv::DtChannelGridLines::setModelDefinition

(

const std::string &

modelDefinition

)

Set the model definition; note that this (potentially) includes all the other parameters enumeration below.

void makVrv::DtChannelGridLines::setGridType

(

unsigned

gridType

)

Set the grid type.

void makVrv::DtChannelGridLines::setUnitType	(	unsigned	unitType,
		bool	isAngular
	)

Set the unit type.

void makVrv::DtChannelGridLines::setAutoSpacing

(

bool

autoSpacing

)

Set whether auto spacing is used.

void makVrv::DtChannelGridLines::setFixedSpacingAmount

(

double

amount

)

Set the fixed spacing amount.

void makVrv::DtChannelGridLines::setMinSpacing

(

int

pixels

)

Set the minimum pixel spacing for auto spacing.

void makVrv::DtChannelGridLines::setXOffset

(

double

offset

)

Set the x offset for the origin.

void makVrv::DtChannelGridLines::setYOffset

(

double

offset

)

Set the y offset for the origin.

void makVrv::DtChannelGridLines::setDecimalPlaces

(

unsigned

decimalPlaces

)

Set the decimalPlaces to use.

virtual void makVrv::DtChannelGridLines::setMaxGridLines ( int  maxGridLines )

virtual

The remaining parameters are normally set through the model definition If you call any of these functions BEFORE the model definition is set, and that parameter is in the model definition, it will override the value set by the mutator.

Set the max number of grid lines in each direction

virtual void makVrv::DtChannelGridLines::setEastWestGridLineColor ( float  r, float  g, float  b, float  a  )

virtual

Set the color of east-west grid lines.

virtual void makVrv::DtChannelGridLines::setEastWestLabelColor ( float  r, float  g, float  b, float  a  )

virtual

Set the color of the labels on east-west grid lines.

virtual void makVrv::DtChannelGridLines::setNorthSouthGridLineColor ( float  r, float  g, float  b, float  a  )

virtual

Set the color of north-south grid lines.

virtual void makVrv::DtChannelGridLines::setNorthSouthLabelColor ( float  r, float  g, float  b, float  a  )

virtual

Set the color of the labels north-south grid lines.

virtual void makVrv::DtChannelGridLines::setLabelFont ( const std::string &  fontName )

virtual

Set the font used for labels.

virtual void makVrv::DtChannelGridLines::setLabelPointSize ( int  pointSize )

virtual

Set the point size used for labels.

virtual void makVrv::DtChannelGridLines::setLabelXOffset ( int  pixels )

virtual

Set the offset of labels from the bottom of the screen.

virtual void makVrv::DtChannelGridLines::setLabelYOffset ( int  pixels )

virtual

Set the offset of labels from the left side of the screen.

virtual void makVrv::DtChannelGridLines::setLabelTextWidth ( int  width )

virtual

Set the width of the box used to display text in.

virtual void makVrv::DtChannelGridLines::setLabelTextHeight ( int  height )

virtual

Set the height of the box used to display text in.

virtual void makVrv::DtChannelGridLines::setGridLineWidth ( float  width )

virtual

Set the width of grid lines.

Member Data Documentation

DtChannelGridLinesInstance* makVrv::DtChannelGridLines::myInstance

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtChannelGridLines.h