bridges.circle.Circle Class Reference

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

Inheritance diagram for bridges.circle.Circle:

Public Member Functions
None	__init__ (self, **kwargs)
	Constructor for a circle symbol.
str	get_shape_type (self)
	Gets the name of the shape/symbol.
None	set_circle (self, locx, locy, r)
	Set the location and size of the circle.
dict	get_json_representation (self)
	Get the json representation of the Circle object.
Public Member Functions inherited from bridges.symbol.Symbol
	print_mat (self, list m)
	print the current matrix for debugging
list	identity (self, list m)
	create the identity matrix
list	mat_mult (self, list m1, list m2)
list	vec_mat_mult (self, list m, list v)
	translate (self, float tx, float ty)
	scale (self, *args)
	scale the symbol from a particular center location
	rotate (self, *args)
	set_transform (self, float a, float b, float c, float d, float e, float f)
	add_all_json (self, symbol_json, parent)

Protected Attributes
	_locx
	_locy
	_radius
Protected Attributes inherited from bridges.symbol.Symbol
	_label
	_fill_color
	_stroke_color
	_opacity
	_stroke_width
	_stroke_dash
	_layer
	_transform
	_xform
	_xform_flag

Properties
	radius = property
	Getter function for the radius of this circle.
	center = property
Properties inherited from bridges.symbol.Symbol
	label = property
	Getter for symbol label.
	fill_color = property
	Getter for the fill color.
	stroke_color = property
	Getter for the stroke color.
	stroke_width = property
	Getter for the stroke width.
	opacity = property
	Getter for opacity.
	stroke_dash = property
	Getter for stroke_dash.
	layer = property
	xform = property

Detailed Description

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

A circle has a radius and a center, which is also its location

Author

Matthew Mcquaigue

Date

2018, 7/23/19

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

Constructor & Destructor Documentation

__init__()

None bridges.circle.Circle.__init__	(		self,
		**	kwargs
	)

Constructor for a circle symbol.

       (int) locx: x location of the circle
       (int) locy: y location of the circle
       (float) r: radius of the circle

Returns

None

Exceptions

ValueError

if the radius is not a positive number

Reimplemented from bridges.symbol.Symbol.

Member Function Documentation

get_json_representation()

dict bridges.circle.Circle.get_json_representation

(

self

)

Get the json representation of the Circle object.

Returns

dict representing the JSON

Reimplemented from bridges.symbol.Symbol.

get_shape_type()

str bridges.circle.Circle.get_shape_type

(

self

)

Gets the name of the shape/symbol.

Returns

str representing the name

Reimplemented from bridges.symbol.Symbol.

set_circle()

None bridges.circle.Circle.set_circle	(		self,
			locx,
			locy,
			r
	)

Set the location and size of the circle.

       (float) locx: x coordinate of the center of the circle
       (float) locy: y coordinate of the center of the circle
       (float) r: radius of the circle

Returns

None

Exceptions

ValueError

if the radius is not a positive number

Member Data Documentation

_locx

bridges.circle.Circle._locx

protected

_locy

bridges.circle.Circle._locy

protected

_radius

bridges.circle.Circle._radius

protected

Property Documentation

center

bridges.circle.Circle.center = property

static

radius

bridges.circle.Circle.radius = property

static

Getter function for the radius of this circle.

Returns

float representing radius

---

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

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