Annotation Class Reference

Instances of this class represent annotations in Vinci. More...

Inheritance diagram for Annotation:

List of all members.

Public Member Functions
function	Annotation (in connection, in target)
	Creates a new proxy object for an annotation in Vinci.
function	assignToImage (in obj, in imageTarget)
function	reinitVDObjects (in obj)
function	sendMessageToMe (in obj, in xmlStr)
	Sends a message to Vinci's counterpart of the VinciObject and receives an answer.
function	sendMessageToTarget (in obj, in target, in xmlStr)
	Sends a message to some target and receives an answer.
function	sendMessageToMeNoAnswer (in obj, in xmlStr)
	Sends a message to the VinciObject and tells Vinci to don't send an answer.
function	sendMessageToTargetNoAnswer (in obj, in target, in xmlStr)
	Sends a message to some target and tells Vinci to don't send an answer.
function	getTargetPartNumber (in obj, in partName)
	Returns the number specified in a part of a target name.
Static Public Member Functions
static function	createNewAnnotation (in connection, in annotationName, in text, in position, in size, in orthopart, in color, in rotation, in imgTarget, in measure)
	This function is for internal use only.
static function	createAnnotationCall (in annotationName, in text, in orthopart, in color, in rotation, in imgTarget, in measure)
	This function is for internal use only.
static function	getIdFromTarget (in connect, in target)
static function	getTargetNameQuery (in id)
static function	getTargetFromId (in connect, in id)
Public Attributes
Property	text
	A string. The text displayed by the annotation.
Property	bold
	A logical.
Property	italic
	A logical.
Property	underscore
	A logical. If underscore is true, the text is underlined.
Property	strikeThrough
	A logical.
Property	fontSize
	A float number. The size of the text in points.
Property	shadowColor
	A triple [r, g, b] with integer values between 0 and 255 for r, g and b.
Property	shadowMode
	A logical. If shadowMode is enabled, a text shadow is visible.
Property	font
	A string. The name of the font family.
Property	position
	A tuple [x y] of floats.
Property	name
	A string. The name of the display object.
Property	rotation
	A double. The rotation of the display object in radians.
Property	color
	The color of the display object.
Property	orthopart
	A string.
Property	selected
	A boolean.
Property< ReadOnly >	type
	A string.
Property< ReadOnly >	id
Property< ReadOnly >	connection
	The Vinci.Connect object used to communicate with Vinci.
Property< ReadOnly >	target
	The target name of the Vinci.VinciObject.
Protected Member Functions
function	getRotation (in obj)
function	setRotation (in obj, in rotation)
function	getSelected (in obj)
function	setSelected (in obj, in selected)

---

Detailed Description

Instances of this class represent annotations in Vinci.

Annotations display text on top of an image. The text can be bold, italic, underlined or striked through. One can set or query the font size and family and add a colored shadow to the text. The position of the text is given in display coordinates and refers to the upper left corner of the text entry.

---

Constructor & Destructor Documentation

function Annotation	(	in	connection,
		in	target
	)

Creates a new proxy object for an annotation in Vinci.

The annotation object must already exist in Vinci.

Usage:

• obj = Vinci.Annotation(connection, target)

Parameters:

connection	A Vinci.Connect object. Used to communicate with Vinci.
target	A string. The target name of the annotation object in Vinci.

Return values:

obj	The created proxy object of type Vinci.Annotation.

See also:

Vinci.Image.createAnnotation

---

Member Function Documentation

function assignToImage	(	in	obj,
		in	imageTarget
	)		[inherited]

static function createAnnotationCall	(	in	annotationName,
		in	text,
		in	orthopart,
		in	color,
		in	rotation,
		in	imgTarget,
		in	measure
	)		[static]

This function is for internal use only.

Please use Vinci.Image.createAnnotation instead.

See also:

Vinci.Image.createAnnotation

static function createNewAnnotation	(	in	connection,
		in	annotationName,
		in	text,
		in	position,
		in	size,
		in	orthopart,
		in	color,
		in	rotation,
		in	imgTarget,
		in	measure
	)		[static]

This function is for internal use only.

Please use Vinci.Image.createAnnotation instead.

See also:

Vinci.Image.createAnnotation

static function getIdFromTarget	(	in	connect,
		in	target
	)		[static, inherited]

function getRotation

(

in

obj

)

[protected, inherited]

Reimplemented in Measure.

function getSelected

(

in

obj

)

[protected, inherited]

static function getTargetFromId	(	in	connect,
		in	id
	)		[static, inherited]

static function getTargetNameQuery

(

in

id

)

[static, inherited]

function getTargetPartNumber	(	in	obj,
		in	partName
	)		[inherited]

Returns the number specified in a part of a target name.

Target names consist of a hierarchy of numbered objects, e.g. '::Project_0::Image_3'. This function returns the number to a given object.

Usage:

• number = obj.getTargetPartNumber(partNumber)

Parameters:

obj	The Vinci.VinciObject instance. The target property of this object is used as target name.
partName	A substring of the target name for which the number should be returned. Examples are 'Project_' or 'Image'. The trailing _ can be left out.

Return values:

number

The number extracted from the target name of the object.

Examples:

  >> obj = Vinci.VinciObject(connection, '::Project_0::Image_3');
  >> imageNumber = obj.getTargetPartNumber('Image')
  % imageNumber is 3 (as an float)

function reinitVDObjects

(

in

obj

)

[inherited]

function sendMessageToMe	(	in	obj,
		in	xmlStr
	)		[inherited]

Sends a message to Vinci's counterpart of the VinciObject and receives an answer.

Usage:

• answer = obj.sendMessageToMe(xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
xmlStr	A string. The message Matlab sends to Vinci.

Return values:

answer

A string. The answer returned by Vinci.

function sendMessageToMeNoAnswer	(	in	obj,
		in	xmlStr
	)		[inherited]

Sends a message to the VinciObject and tells Vinci to don't send an answer.

Usage:

• obj.sendMessageToMeNoAnswer(xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
xmlStr	A string. The message Matlab sends to Vinci.

function sendMessageToTarget	(	in	obj,
		in	target,
		in	xmlStr
	)		[inherited]

Sends a message to some target and receives an answer.

Usage:

• answer = obj.sendMessageToTarget(target, xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
target	A string. The name of the target.
xmlStr	A string. The message Matlab sends to Vinci.

Return values:

answer

A string. The answer returned by Vinci.

function sendMessageToTargetNoAnswer	(	in	obj,
		in	target,
		in	xmlStr
	)		[inherited]

Sends a message to some target and tells Vinci to don't send an answer.

Usage:

• obj.sendMessageToTarget(target, xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
target	A string. The name of the target.
xmlStr	A string. The message Matlab sends to Vinci.

function setRotation	(	in	obj,
		in	rotation
	)		[protected, inherited]

Reimplemented in Measure.

function setSelected	(	in	obj,
		in	selected
	)		[protected, inherited]

Reimplemented in Measure.

---

Member Data Documentation

Property bold

A logical.

If bold is true, the text is displayed in bold characters.

Property color [inherited]

The color of the display object.

Stored as a [r, g, b] triple. Color channels are stored as integers between 0 and 255. Valid colors are for example [0 255 13] or [18 23 255].

Property<ReadOnly> connection [inherited]

The Vinci.Connect object used to communicate with Vinci.

This object determines, with which instance of Vinci the object will talk.

Property font

A string. The name of the font family.

Property fontSize

A float number. The size of the text in points.

Property<ReadOnly> id [inherited]

Property italic

A logical.

If italic is true, the text is display in italics.

Property name [inherited]

A string. The name of the display object.

Property orthopart [inherited]

A string.

The name of the part of the ortho display, which displays the object. Find possible values in Vinci.Constants.Orthoparts.

Property position

A tuple [x y] of floats.

The position of the text in display coordinates. [0 1] positions the text in the top left corner of the display.

Property rotation [inherited]

A double. The rotation of the display object in radians.

Property selected [inherited]

A boolean.

true if the object is selected and false otherwise.

Property shadowColor

A triple [r, g, b] with integer values between 0 and 255 for r, g and b.

The color of the shadow.

Property shadowMode

A logical. If shadowMode is enabled, a text shadow is visible.

Property strikeThrough

A logical.

If strikeThrough is true, the text is displayed in a striked through manner.

Property<ReadOnly> target [inherited]

The target name of the Vinci.VinciObject.

Target names are strings in the form '::', '::Project_0' or '::Project_0::Image_0'.

Property text

A string. The text displayed by the annotation.

Property<ReadOnly> type [inherited]

A string.

The type of the display object. You can find supported values in Vinci.Constants.DisplayObjectTypes.

Property underscore

A logical. If underscore is true, the text is underlined.

---

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

• Annotation.m