Aimsun Next Scripting: GKViewModeStyleRange Class Reference
Aimsun Next Scripting  22
Public Types | Public Member Functions | Public Attributes | List of all members
GKViewModeStyleRange Class Reference

Public Types

enum  SpotType {
  eNone , eCircle , eStar , eText ,
  eIcon , eAttribute , eDiagram , eDirectionRectangle ,
  eDirectionArrow
}
 
enum  DiagramType {
  eDiagramCircles = 0 , eDiagramPie , eDiagramHistogram , eDiagramStackedHistogram ,
  eDiagramStar
}
 

Public Member Functions

 GKViewModeStyleRange ()
 
 ~GKViewModeStyleRange ()
 
void setViewModeStyle (GKViewModeStyle *style)
 
GKViewModeStylegetViewModeStyle () const
 
void setRangeValues (double from, double to)
 
double getStartingValue () const
 
double getEndingValue () const
 
float getPenSize () const
 
float getPenSize (GKObject *obj, const GKModelConnection *modelConn, const GKContext &context) const
 
float getMaxPenSize () const
 
void setPenSize (float value)
 
void setPenSize (float minSize, float maxSize)
 
float getPenSize (GKObject *obj, const GKViewModeStyleRangeDiagramColumn &diagramCol, const GKModelConnection *modelConn, const GKContext &context) const
 

Public Attributes

QString label
 
double from
 
double to
 
QColor color
 
float alpha
 
GK::SizeUnits penSizeUnits
 
Qt::BrushStyle brushStyle
 
Qt::PenStyle penStyle
 
SpotType spot
 
bool useSpotColor
 
GKColumnattr
 
QString strLabel
 
bool showColumnUnits
 
bool showColumnName
 
Qt::Alignment alignment
 
QVector< GKViewModeStyleRangeDiagramColumnattrList
 
DiagramType diagramType
 

Detailed Description

It modifies only one visualization attribute.

Member Enumeration Documentation

◆ DiagramType

Diagram type.

Enumerator
eDiagramCircles 
eDiagramPie 
eDiagramHistogram 
eDiagramStackedHistogram 
eDiagramStar 

◆ SpotType

Enumerator
eNone 
eCircle 
eStar 
eText 
eIcon 
eAttribute 
eDiagram 
eDirectionRectangle 
eDirectionArrow 

Constructor & Destructor Documentation

◆ GKViewModeStyleRange()

GKViewModeStyleRange::GKViewModeStyleRange ( )

◆ ~GKViewModeStyleRange()

GKViewModeStyleRange::~GKViewModeStyleRange ( )

Member Function Documentation

◆ getEndingValue()

double GKViewModeStyleRange::getEndingValue ( ) const

Returns the ending value for this range

◆ getMaxPenSize()

float GKViewModeStyleRange::getMaxPenSize ( ) const

Maximum pen size for proportional mode.

◆ getPenSize() [1/3]

float GKViewModeStyleRange::getPenSize ( ) const

Pen size.

◆ getPenSize() [2/3]

float GKViewModeStyleRange::getPenSize ( GKObject obj,
const GKModelConnection modelConn,
const GKContext context 
) const

◆ getPenSize() [3/3]

float GKViewModeStyleRange::getPenSize ( GKObject obj,
const GKViewModeStyleRangeDiagramColumn diagramCol,
const GKModelConnection modelConn,
const GKContext context 
) const

get Pen size using the column held by diagramCol instead of the "attribute"

◆ getStartingValue()

double GKViewModeStyleRange::getStartingValue ( ) const

Returns the starting value for this range

◆ getViewModeStyle()

GKViewModeStyle * GKViewModeStyleRange::getViewModeStyle ( ) const

Returns the style where it belongs to.

◆ setPenSize() [1/2]

void GKViewModeStyleRange::setPenSize ( float  minSize,
float  maxSize 
)

Set the pen size for proportional mode.

◆ setPenSize() [2/2]

void GKViewModeStyleRange::setPenSize ( float  value)

Set the pen size.

◆ setRangeValues()

void GKViewModeStyleRange::setRangeValues ( double  from,
double  to 
)

Sets the start and end values for this range

◆ setViewModeStyle()

void GKViewModeStyleRange::setViewModeStyle ( GKViewModeStyle style)

Sets the view style.

Member Data Documentation

◆ alignment

Qt::Alignment GKViewModeStyleRange::alignment

Label alignment.

◆ alpha

float GKViewModeStyleRange::alpha

alpha color representation factor

◆ attr

GKColumn* GKViewModeStyleRange::attr

Attribute used to build the range.

◆ attrList

QVector<GKViewModeStyleRangeDiagramColumn> GKViewModeStyleRange::attrList

Shown attributes (in case of a diagram)

◆ brushStyle

Qt::BrushStyle GKViewModeStyleRange::brushStyle

Painting brush style.

◆ color

QColor GKViewModeStyleRange::color

Color representation.

◆ diagramType

DiagramType GKViewModeStyleRange::diagramType

◆ from

double GKViewModeStyleRange::from

range boundary lower value

◆ label

QString GKViewModeStyleRange::label

label having context information about range

◆ penSizeUnits

GK::SizeUnits GKViewModeStyleRange::penSizeUnits

Pen size units (pixels or m)

◆ penStyle

Qt::PenStyle GKViewModeStyleRange::penStyle

Painting pen style.

◆ showColumnName

bool GKViewModeStyleRange::showColumnName

Show the column name.

◆ showColumnUnits

bool GKViewModeStyleRange::showColumnUnits

Show the column units.

◆ spot

SpotType GKViewModeStyleRange::spot

◆ strLabel

QString GKViewModeStyleRange::strLabel

Shown label when a text configuration is set.

◆ to

double GKViewModeStyleRange::to

range boundary top value

◆ useSpotColor

bool GKViewModeStyleRange::useSpotColor

holds if the specified color must be used or not.

© Aimsun SLU
Aimsun ®