GL Studio C++ Runtime API
GlsLinearScaleData Class Reference

#include <gls_linear_scale.h>

Public Member Functions

 GlsLinearScaleData (bool _active, bool _useLineColor, unsigned int _ticks, float _startingOffset, float _interval, float _length, float _thickness, const GlsColor &_color)
 
 GlsLinearScaleData (const GlsLinearScaleData &src)
 
GlsLinearScaleDataoperator= (const GlsLinearScaleData &src)
 
bool operator== (const GlsLinearScaleData &right) const
 
bool operator!= (const GlsLinearScaleData &right) const
 
void InitMetaData ()
 Create DistiAttributes for this object's members.
 
std::ostream & WriteValue (std::ostream &outstr)
 
std::istream & ReadValue (std::istream &instr)
 

Public Attributes

bool active
 True if this scale is active.
 
bool useLineColor
 True if this scale draws with line color.
 
unsigned int ticks
 Number of ticks on this scale.
 
float startingOffset
 Start offset in logical units.
 
float interval
 Interval between ticks in logical units.
 
float length
 Length of ticks in logical units.
 
float thickness
 Thickness of ticks in logical units.
 
GlsColor color
 Color to draw ticks if line color is not being used.
 

Protected Attributes

DistiAttribDict _attribDict
 The attribute dictionary for this class' members.
 

Detailed Description

The GlsLinearScaleData class. Stores information for the appearance of one set of tick marks.

Constructor & Destructor Documentation

◆ GlsLinearScaleData() [1/2]

GlsLinearScaleData ( bool  _active,
bool  _useLineColor,
unsigned int  _ticks,
float  _startingOffset,
float  _interval,
float  _length,
float  _thickness,
const GlsColor _color 
)
inline

Constructor

Parameters
_activeTrue if this scale is active.
_useLineColorTrue if this scale draws with line color.
_ticksNumber of ticks on this scale.
_startingOffsetStart offset in logical units.
_intervalInterval between ticks in degrees.
_lengthLength of ticks in logical units.
_thicknessThickness of ticks in logical units.
_colorColor to draw ticks if line color is not being used.

◆ GlsLinearScaleData() [2/2]

GlsLinearScaleData ( const GlsLinearScaleData src)
inline

Copy constructor

Parameters
srcThe object to copy from.

Member Function Documentation

◆ operator!=()

bool operator!= ( const GlsLinearScaleData right) const
inline

Inequality operator

Parameters
rightThe object to compare.
Returns
Whether or not the objects are not equal.

◆ operator=()

GlsLinearScaleData & operator= ( const GlsLinearScaleData src)
inline

Assignment operator

Parameters
srcThe object to copy from.
Returns
The resulting object (this).

◆ operator==()

bool operator== ( const GlsLinearScaleData right) const

Equality operator

Parameters
rightThe object to compare.
Returns
Whether or not the objects are equal.

◆ ReadValue()

std::istream & ReadValue ( std::istream &  instr)

Reads this from a stream.

Parameters
instrThe stream to read from.
Returns
The stream in its current state.

◆ WriteValue()

std::ostream & WriteValue ( std::ostream &  outstr)

Writes this to a stream.

Parameters
outstrThe stream to write to.
Returns
The stream in its current state.

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