Chemical Data Processing Library Python API - Version 1.2.0
Public Member Functions | Properties | List of all members
CDPL.Vis.EllipsePrimitive2D Class Reference

A graphics primitive representing a ellipse. More...

+ Inheritance diagram for CDPL.Vis.EllipsePrimitive2D:

Public Member Functions

None __init__ ()
 Constructs an undefined ellipse primitive.
 
None __init__ (Math.Vector2D pos, float width, float height)
 Constructs an undefined ellipse primitive.
 
None __init__ (EllipsePrimitive2D prim)
 Initializes a copy of the EllipsePrimitive2D instance prim. More...
 
EllipsePrimitive2D assign (EllipsePrimitive2D prim)
 Replaces the current state of self with a copy of the state of the EllipsePrimitive2D instance prim. More...
 
None setWidth (float width)
 Sets the diameter of the ellipse in x-direction. More...
 
float getWidth ()
 Returns the diameter of the ellipse in x-direction. More...
 
None setHeight (float height)
 Sets the diameter of the ellipse in y-direction. More...
 
float getHeight ()
 Returns the diameter of the ellipse in y-direction. More...
 
None setPosition (Math.Vector2D pos)
 Sets the position of the ellipse center. More...
 
Math.Vector2D getPosition ()
 Returns the position of the ellipse center. More...
 
None setPen (Pen pen)
 Sets the pen defining the color, width, line style, cap style and join style of the ellipse outline. More...
 
Pen getPen ()
 Returns the pen defining the color, width, line style, cap style and join style of the ellipse outline. More...
 
None setBrush (Brush brush)
 Sets the brush defining the fill color and fill pattern. More...
 
Brush getBrush ()
 Returns the brush defining the fill color and fill pattern. More...
 
- Public Member Functions inherited from CDPL.Vis.GraphicsPrimitive2D
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
None render (Renderer2D renderer)
 Visualizes the graphics primitive by means of the Renderer2D instance renderer. More...
 
None getBounds (Rectangle2D bounds, FontMetrics font_metrics=0)
 Calculates the bounds of the graphics primitive. More...
 
GraphicsPrimitive2D clone ()
 Creates a dynamically allocated copy of the graphics primitive. More...
 

Properties

 width = property(getWidth, setWidth)
 
 height = property(getHeight, setHeight)
 
 position = property(getPosition, setPosition)
 
 pen = property(getPen, setPen)
 
 brush = property(getBrush, setBrush)
 
- Properties inherited from CDPL.Vis.GraphicsPrimitive2D
 objectID = property(getObjectID)
 

Detailed Description

A graphics primitive representing a ellipse.

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Vis.EllipsePrimitive2D.__init__ ( EllipsePrimitive2D  prim)

Initializes a copy of the EllipsePrimitive2D instance prim.

Parameters
primThe EllipsePrimitive2D instance to copy.

Member Function Documentation

◆ assign()

EllipsePrimitive2D CDPL.Vis.EllipsePrimitive2D.assign ( EllipsePrimitive2D  prim)

Replaces the current state of self with a copy of the state of the EllipsePrimitive2D instance prim.

Parameters
primThe EllipsePrimitive2D instance to copy.
Returns
self

◆ setWidth()

None CDPL.Vis.EllipsePrimitive2D.setWidth ( float  width)

Sets the diameter of the ellipse in x-direction.

Parameters
widthThe width of the ellipse.

◆ getWidth()

float CDPL.Vis.EllipsePrimitive2D.getWidth ( )

Returns the diameter of the ellipse in x-direction.

Returns
The width of the ellipse.

◆ setHeight()

None CDPL.Vis.EllipsePrimitive2D.setHeight ( float  height)

Sets the diameter of the ellipse in y-direction.

Parameters
heightThe height of the ellipse.

◆ getHeight()

float CDPL.Vis.EllipsePrimitive2D.getHeight ( )

Returns the diameter of the ellipse in y-direction.

Returns
The height of the ellipse.

◆ setPosition()

None CDPL.Vis.EllipsePrimitive2D.setPosition ( Math.Vector2D  pos)

Sets the position of the ellipse center.

Parameters
posThe center position of the ellipse.

◆ getPosition()

Math.Vector2D CDPL.Vis.EllipsePrimitive2D.getPosition ( )

Returns the position of the ellipse center.

Returns
The center position of the ellipse.

◆ setPen()

None CDPL.Vis.EllipsePrimitive2D.setPen ( Pen  pen)

Sets the pen defining the color, width, line style, cap style and join style of the ellipse outline.

Parameters
penThe pen defining the color, width, line style, cap style and join style of the ellipse's outline.

◆ getPen()

Pen CDPL.Vis.EllipsePrimitive2D.getPen ( )

Returns the pen defining the color, width, line style, cap style and join style of the ellipse outline.

Returns
The pen defining the color, width, line style, cap style and join style of the ellipse outline.

◆ setBrush()

None CDPL.Vis.EllipsePrimitive2D.setBrush ( Brush  brush)

Sets the brush defining the fill color and fill pattern.

Parameters
brushThe brush defining the fill color and fill pattern.

◆ getBrush()

Brush CDPL.Vis.EllipsePrimitive2D.getBrush ( )

Returns the brush defining the fill color and fill pattern.

Returns
The brush defining the fill color and fill pattern.