ALBULA  4.0.1
 All Classes Namespaces Functions Variables Pages
dectris.albula.DDrawingEllipse Class Reference

class DDrawingEllipse is a DDrawingPrimitive that represents a ellipse in the viewer window. More...

Inheritance diagram for dectris.albula.DDrawingEllipse:
dectris.albula.DDrawingPrimitive

Public Member Functions

def DDrawingEllipse
 Contruct DDrawingEllipse. More...
 
def x
 X position of the centre. More...
 
def y
 Y position of the centre. More...
 
def rx
 X-Radius. More...
 
def ry
 Y-Radius. More...
 
def rotation
 Angle in radians by which the ellipse is rotated clockwise around its centre. More...
 
def setX
 Set X position of the centre. More...
 
def setY
 Set Y position of the centre. More...
 
def setRx
 Set X-Radius. More...
 
def setRy
 Set Y-Radius. More...
 
def setRotation
 Set rotation angle. More...
 
- Public Member Functions inherited from dectris.albula.DDrawingPrimitive
def type
 Returns the type of the primitve. More...
 
def red
 red component of the color. More...
 
def green
 green component of the color. More...
 
def blue
 blue component of the color. More...
 
def alpha
 alpha component of the color. More...
 
def setColor
 Set the red, green, blue and alpha component of the color. More...
 

Detailed Description

class DDrawingEllipse is a DDrawingPrimitive that represents a ellipse in the viewer window.

It is defined by its centre (x,y) its x and y radius (rx, ry) and a rotation angle (rotation), which rotates the ellipse clockwise around its centre.

Constructor & Destructor Documentation

def dectris.albula.DDrawingEllipse.DDrawingEllipse (   x,
  y,
  rx,
  ry,
  rotation,
  red,
  green,
  blue,
  alpha = 255 
)

Contruct DDrawingEllipse.

Pass the centre (x,y) the radius (rx, ry) and a rotation angle (rotation), which rotates the ellipse clockwise around its centre.

Parameters
xFloat. X position of the centre.
yFloat. Y position of the centre.
rxFloat. X-Radius.
ryFloat. Y-Radius.
rotationFloat. Angle in radians by which the ellipse is rotated clockwise around its centre.
redInteger between 0 and 255
greenInteger between 0 and 255
blueInteger between 0 and 255
alphaInteger between 0 and 255. alpha defines the opacity of the displayed primitive.

Member Function Documentation

def dectris.albula.DDrawingEllipse.rotation ( )

Angle in radians by which the ellipse is rotated clockwise around its centre.

Returns
Float.
def dectris.albula.DDrawingEllipse.rx ( )

X-Radius.

Returns
Float.
def dectris.albula.DDrawingEllipse.ry ( )

Y-Radius.

Returns
Float.
def dectris.albula.DDrawingEllipse.setRotation (   rotation)

Set rotation angle.

Angle in radians by which the ellipse is rotated clockwise around its centre.

Parameters
rotationFloat.
def dectris.albula.DDrawingEllipse.setRx (   rx)

Set X-Radius.

Parameters
rxFloat.
def dectris.albula.DDrawingEllipse.setRy (   ry)

Set Y-Radius.

Parameters
ryFloat.
def dectris.albula.DDrawingEllipse.setX (   x)

Set X position of the centre.

Parameters
xFloat.
def dectris.albula.DDrawingEllipse.setY (   y)

Set Y position of the centre.

Parameters
yFloat.
def dectris.albula.DDrawingEllipse.x ( )

X position of the centre.

Returns
Float.
def dectris.albula.DDrawingEllipse.y ( )

Y position of the centre.

Returns
Float.