ALBULA  4.0.1
dectris.albula.DDrawingLine Class Reference

class DDrawingLine is a DDrawingPrimitive that represents a line in the viewer window. More...

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

Public Member Functions

def DDrawingLine (xBegin, xEnd, yBegin, yEnd, red, green, blue, alpha=255)
 Construct DDrawingLine by passing its starting-point and end-poin and its color. More...
 
def xBegin ()
 X starting-point of line. More...
 
def xEnd ()
 X end-point of line. More...
 
def yBegin ()
 Y starting-point of line. More...
 
def yEnd ()
 Y end-point of line. More...
 
def setXBegin (x)
 Set X starting-point of line. More...
 
def setXEnd (x)
 Set X end-point of line. More...
 
def setYBegin (y)
 Set Y starting-point of line. More...
 
def setYEnd (y)
 Set Y end-point of line. 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 (red, green, blue, alpha)
 Set the red, green, blue and alpha component of the color. More...
 

Detailed Description

class DDrawingLine is a DDrawingPrimitive that represents a line in the viewer window.

It is defined by its start and endpoints.

Constructor & Destructor Documentation

◆ DDrawingLine()

def dectris.albula.DDrawingLine.DDrawingLine (   xBegin,
  xEnd,
  yBegin,
  yEnd,
  red,
  green,
  blue,
  alpha = 255 
)

Construct DDrawingLine by passing its starting-point and end-poin and its color.

Parameters
xBeginFloat. X starting-point of line.
xEndFloat. X end-point of line.
yBeginFloat. Y starting-point of line.
yEndFloat. Y end-point of line.
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

◆ setXBegin()

def dectris.albula.DDrawingLine.setXBegin (   x)

Set X starting-point of line.

Parameters
xFloat.

◆ setXEnd()

def dectris.albula.DDrawingLine.setXEnd (   x)

Set X end-point of line.

Parameters
xFloat.

◆ setYBegin()

def dectris.albula.DDrawingLine.setYBegin (   y)

Set Y starting-point of line.

Parameters
yFloat.

◆ setYEnd()

def dectris.albula.DDrawingLine.setYEnd (   y)

Set Y end-point of line.

Parameters
yFloat.

◆ xBegin()

def dectris.albula.DDrawingLine.xBegin ( )

X starting-point of line.

Returns
Float.

◆ xEnd()

def dectris.albula.DDrawingLine.xEnd ( )

X end-point of line.

Returns
Float.

◆ yBegin()

def dectris.albula.DDrawingLine.yBegin ( )

Y starting-point of line.

Returns
Float.

◆ yEnd()

def dectris.albula.DDrawingLine.yEnd ( )

Y end-point of line.

Returns
Float.