bridges.polyline.Polyline Class Reference

Inheritance diagram for bridges.polyline.Polyline:

Detailed Description

This class defines a polygon and is part of the symbol collection.

A polygon has a set of vertices, with vertices connected by line segments. It differs from the polyline in the sense that the last and first vertex are connect to close the shape.

Author

David Burlinson, Kalpathi Subramanian

Date

2018, 7/23/19, 1/2/21

See also

Shape collection tutorial, http://bridgesuncc.github.io/tutorials/Symbol_Collection.html

Public Member Functions
def	__init__ (self, pts=None)
	Constructor. More...
def	get_name (self)
	Get the name of the symbol. More...
def	add_point (self, x, y)
	Add a point to the polyline. More...
def	points (self)
	Get the number of points in polyline. More...
def	points (self, pts)
	Set the number of points in polyline. More...
def	get_dimensions (self)
	Get the bounding box of the polyline. More...
def	translate (self, tx, ty)
	Translate the polyline by tx, ty along X and Y respectively. More...
def	rotate (self, angle)
	Rotat the polyline by 'angle' (2D rotation) More...
def	scale (self, sx, sy)
	Scale the polyline by sx, sy along X and Y respectively. More...
def	get_center (self, center)
	Get the center of the polyline (use the bounding box center) More...
def	get_json_representation (self)
Public Member Functions inherited from bridges.symbol.Symbol
def	__init__ (self)
	Constructor for a Symbol. More...
def	label (self)
	Getter for symbol label. More...
def	label
	Setter for symbol label. More...
def	identifier (self)
	Getter for the symbols identifier. More...
def	fill_color (self)
	Getter for the fill color. More...
def	fill_color (self, args, kwargs)
	Setter for the fill color. More...
def	stroke_color (self)
	Getter for the stroke color. More...
def	stroke_color (self, args, kwargs)
	Setter for the stroke color. More...
def	stroke_width (self)
	Getter for the stroke width. More...
def	stroke_width
	Setter for the stroke width. More...
def	opacity (self)
	Getter for opacity. More...
def	opacity
	Setter for opacity. More...
def	stroke_dash (self)
	Getter for stroke_dash. More...
def	stroke_dash
	Setter for stroke_dash. More...
def	shape_type (self)
	Get the shape type (string) More...
def	shape_type (self, shape)
	Set the shape type (string) More...
def	set_location
	Setter for the location of the center of the symbol. More...
def	get_location (self)
	Getter for the location of a symbol. More...
def	get_dimensions (self)
	Getter for the dimensions. More...
def	translate_point (self, pt, tx, ty)
	Translate a point by tx, ty along X and Y respectively. More...
def	scale_point (self, pt, sx, sy)
	Scale a point by sx, sy along X and Y respectively. More...
def	rotate_point (self, pt, angle)
	Rotate a point by 'angle' (2D rotation) More...
def	get_json_representation (self)
	Get the json representation of the Symbol class. More...

Constructor & Destructor Documentation

__init__()

def bridges.polyline.Polyline.__init__	(		self,
			pts = None
	)

Constructor.

Sets the number of points in the polyline

Parameters

pts	number of points to be used in constructing the polyline

Member Function Documentation

add_point()

def bridges.polyline.Polyline.add_point	(		self,
			x,
			y
	)

Add a point to the polyline.

Parameters

x	point's x coordinate
y	point's y coordinate

get_center()

def bridges.polyline.Polyline.get_center	(		self,
			center
	)

Get the center of the polyline (use the bounding box center)

Parameters

center

[output] returns the computed center as a 2 element list

get_dimensions()

def bridges.polyline.Polyline.get_dimensions

(

self

)

Get the bounding box of the polyline.

get_json_representation()

def bridges.polyline.Polyline.get_json_representation

(

self

)

get_name()

def bridges.polyline.Polyline.get_name

(

self

)

Get the name of the symbol.

Returns

the symbol name

points() [1/2]

def bridges.polyline.Polyline.points

(

self

)

Get the number of points in polyline.

Returns

the number of points in symbol.

points() [2/2]

def bridges.polyline.Polyline.points	(		self,
			pts
	)

Set the number of points in polyline.

Parameters

pts	the number of points in symbol.

rotate()

def bridges.polyline.Polyline.rotate	(		self,
			angle
	)

Rotat the polyline by 'angle' (2D rotation)

Parameters

angle

angle of rotation in degrees

scale()

def bridges.polyline.Polyline.scale	(		self,
			sx,
			sy
	)

Scale the polyline by sx, sy along X and Y respectively.

Parameters

sx	scale factor in X
sy	scale factor in Y

translate()

def bridges.polyline.Polyline.translate	(		self,
			tx,
			ty
	)

Translate the polyline by tx, ty along X and Y respectively.

Parameters

tx	translation factor in X
ty	translation factor in Y

---

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

• /home/erik/work/bridges/bridges-python/bridges/polyline.py