Bridges-C++  3.2.0
Bridges(C++API)
Public Member Functions | List of all members
bridges::datastructure::Rectangle Class Reference

#include <Rectangle.h>

Inheritance diagram for bridges::datastructure::Rectangle:
bridges::datastructure::Symbol

Detailed Description

This class defines a rectangle and is part of the symbol collection. A rectangle has height and width.

Author
Kalpathi Subramanian
Date
12/23/18, 7/12/19

Public Member Functions

 Rectangle ()
 default constructor - rectangle with lower left at origin and unit length sides More...
 
 Rectangle (int w, int h)
 create rectangle with width w and height h More...
 
 Rectangle (float locx, float locy, float w, float h)
 create rectangle with width w and height h and located at given position More...
 
string getDataStructType ()
 This method gets the data type name. More...
 
string getName () const
 This method gets the name of the shape. More...
 
void setWidth (float w)
 This method sets the shape width. More...
 
void setHeight (float h)
 This method sets the shape height. More...
 
void translate (float tx, float ty)
 Translate the rectangle. More...
 
void scale (float sx, float sy)
 Scale the rectangle about its center. More...
 
vector< float > getDimensions () const
 
void setRectangle (float locx, float locy, float w, float h)
 
virtual const string getSymbolRepresentation () const
 This method returns the JSON representation of the shape. More...
 
- Public Member Functions inherited from bridges::datastructure::Symbol
 Symbol ()
 default constructor More...
 
 Symbol (string symb)
 Create a symbol of type "symb". More...
 
int getIdentifier ()
 return the symbol identifier. More...
 
void setLabel (string lbl)
 Set the symbol label. More...
 
string getLabel () const
 Get the symbol label. More...
 
void setFillColor (Color c)
 Set the symbol fill color. More...
 
void setFillColor (string c)
 This method sets the symbol fill color. More...
 
Color getFillColor ()
 This method gets fill color. More...
 
void setStrokeColor (Color c)
 
void setStrokeColor (string c)
 This method sets the symbol stroke color. More...
 
Color getStrokeColor ()
 This method gets stroke color. More...
 
void setStrokeWidth (float strk_width)
 This method sets the symbol stroke width. More...
 
float getStrokeWidth ()
 This method gets stroke width. More...
 
void setOpacity (float op)
 This method sets the symbol opacity. More...
 
float getOpacity ()
 This method gets symbol opacity. More...
 
void setStrokeDash (int dash)
 This method sets the stroke dash level. More...
 
int getStrokeDash ()
 This method gets stroke dash level. More...
 
void setLocation (int x, int y)
 This method sets the symbol location. More...
 
void setLocation (double x, double y)
 This method sets the symbol location. More...
 
void setCenter (float x, float y)
 This method sets the symbol location. More...
 
void setLocation (float x, float y)
 This method sets the ssymbol location. More...
 
const float * getLocation () const
 This method gets the symbol location. More...
 
string getName () const
 This method gets the name of the symbol. More...
 

Additional Inherited Members

- Protected Member Functions inherited from bridges::datastructure::Symbol
void setShapeType (string s)
 Set the shape type. More...
 
string getShapeType () const
 
void translatePoint (float *pt, float tx, float ty)
 Translate a 2D point. More...
 
void scalePoint (float *pt, float sx, float sy)
 Scale a 2D point. More...
 
void rotatePoint (float *pt, float angle)
 Rotate a 2D point (about Z) More...
 
const string getSymbolAttributeRepresentation () const
 Get the JSON of the symbol representation. More...
 

Constructor & Destructor Documentation

◆ Rectangle() [1/3]

bridges::datastructure::Rectangle::Rectangle ( )
inline

default constructor - rectangle with lower left at origin and unit length sides

◆ Rectangle() [2/3]

bridges::datastructure::Rectangle::Rectangle ( int  w,
int  h 
)
inline

create rectangle with width w and height h

Parameters
wwidth
hheight

◆ Rectangle() [3/3]

bridges::datastructure::Rectangle::Rectangle ( float  locx,
float  locy,
float  w,
float  h 
)
inline

create rectangle with width w and height h and located at given position

Parameters
locxrect lower left - x coord
locyrect lower left - y coord
wwidth
hheight

Member Function Documentation

◆ getDataStructType()

string bridges::datastructure::Rectangle::getDataStructType ( )
inline

This method gets the data type name.

Returns
name data type name

◆ getDimensions()

vector<float> bridges::datastructure::Rectangle::getDimensions ( ) const
inlinevirtual

This method returns the dimensions of the shape: min and max values in X and Y

Returns
array of 4 values

Implements bridges::datastructure::Symbol.

◆ getName()

string bridges::datastructure::Rectangle::getName ( ) const
inline

This method gets the name of the shape.

Returns
name shape name

◆ getSymbolRepresentation()

virtual const string bridges::datastructure::Rectangle::getSymbolRepresentation ( ) const
inlinevirtual

This method returns the JSON representation of the shape.

Returns
string JSON string

Implements bridges::datastructure::Symbol.

◆ scale()

void bridges::datastructure::Rectangle::scale ( float  sx,
float  sy 
)
inline

Scale the rectangle about its center.

Parameters
sxscale factor along x axis
syscale factor along y axis

◆ setHeight()

void bridges::datastructure::Rectangle::setHeight ( float  h)
inline

This method sets the shape height.

Parameters
hheight

◆ setRectangle()

void bridges::datastructure::Rectangle::setRectangle ( float  locx,
float  locy,
float  w,
float  h 
)
inline

◆ setWidth()

void bridges::datastructure::Rectangle::setWidth ( float  w)
inline

This method sets the shape width.

Parameters
wwidth

◆ translate()

void bridges::datastructure::Rectangle::translate ( float  tx,
float  ty 
)
inline

Translate the rectangle.

Parameters
txtranslation factor along x axis
tytranslation factor along y axis

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