dectris.albula.DDrawingString Class Reference

class DDrawingString is a DDrawingPrimitive that represents a string in the viewer window. More...

Inheritance diagram for dectris.albula.DDrawingString:

Public Member Functions
def	DDrawingString (x, y, text, red, green, blue, alpha=255)
	Construct DDrawingString by passing its position, its text content and its color. More...
def	x ()
	X position of the string. More...
def	y ()
	Y position of the string. More...
def	text ()
	Text to be displayed. More...
def	setX (x)
	Set X position of the string. More...
def	setY (y)
	Set Y position of the string. More...
def	setText (text)
	Set text of the string. 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 DDrawingString is a DDrawingPrimitive that represents a string in the viewer window.

The length of the string is restricted to 256 characters.

Constructor & Destructor Documentation

DDrawingString()

def dectris.albula.DDrawingString.DDrawingString	(		x,
			y,
			text,
			red,
			green,
			blue,
			alpha = 255
	)

Construct DDrawingString by passing its position, its text content and its color.

Parameters

x	Float. X position.
y	Float. Y position.
text	String. Text to be displayed. Maximum 256 characters.
red	Integer between 0 and 255
green	Integer between 0 and 255
blue	Integer between 0 and 255
alpha	Integer between 0 and 255. alpha defines the opacity of the displayed primitive.

Member Function Documentation

setText()

def dectris.albula.DDrawingString.setText

(

text

)

Set text of the string.

Maximum 256 characters.

Parameters

text

String.

setX()

def dectris.albula.DDrawingString.setX

(

x

)

Set X position of the string.

Parameters

x

Float

setY()

def dectris.albula.DDrawingString.setY

(

y

)

Set Y position of the string.

Parameters

y

Float

text()

def dectris.albula.DDrawingString.text

(

)

Text to be displayed.

Returns

String.

x()

def dectris.albula.DDrawingString.x

(

)

X position of the string.

Returns

Float

y()

def dectris.albula.DDrawingString.y

(

)

Y position of the string.

Returns

Float