HUtilityAnnotationMeasure

Functions

char const *

GetType

HC_KEY

Insert

HC_KEY

Insert

HC_KEY

InsertWithEncoding

void

MoveText

void

MoveText

void

SetNote

bool

IsMeasurement

void

drawLineCallbackDummy

Detailed Description

class HUtilityAnnotationMeasure : public HUtilityAnnotation

The HUtilityAnnotationMeasure class defines and manages annotations.

This class simplified the creation of measurement annotations.

Public Functions

inline virtual char const *GetType()

Returns “HUtilityAnnotationMeasure”

virtual HC_KEY Insert(HPoint target, HPoint position, HC_KEY AnnotateThis, HBaseView *pView, HC_KEY layer_key = (-1L), int bg_type = 1, bool useArrow = true, HC_KEY *key_path = (HC_KEY*)0, int key_path_length = 0)

Inserts a note

Parameters

  • target – where the arrow should point

  • position – where the text is positioned

  • AnnotateThis – key to what this annotation is annotating

  • pView – pointer to the view

  • layer_key – style segment for this note

  • bg_type – one of four stock background types

  • useArrow – sets the visibility of the arrow

  • key_path – is the key path returned by HC_Show_Selection_Original_Keys

  • key_path_length – is the length returned by HC_Show_Selection_Original_Keys

Returns

key to the root of the note segment tree

virtual HC_KEY Insert(char const *text, HPoint target, HPoint position, HC_KEY AnnotateThis, HBaseView *pView, HC_KEY layer_key = (-1L), int bg_type = 1, bool useArrow = true, HC_KEY *key_path = (HC_KEY*)0, int key_path_length = 0)

Inserts a note

Parameters

  • text – initial text for this note

  • target – where the arrow should point

  • position – where the text is positioned

  • AnnotateThis – key to what this annotation is annotating

  • pView – pointer to the view

  • layer_key – style segment for this note

  • bg_type – one of four stock background types

  • useArrow – sets the visibility of the arrow

  • key_path – is the key path returned by HC_Show_Selection_Original_Keys

  • key_path_length – is the length returned by HC_Show_Selection_Original_Keys

Returns

key to the root of the note segment tree

virtual HC_KEY InsertWithEncoding(unsigned short const *text, HPoint target, HPoint position, HC_KEY AnnotateThis, HBaseView *pView, HC_KEY layer_key = (-1L), int bg_type = 1, bool useArrow = true, HC_KEY *key_path = (HC_KEY*)0, int key_path_length = 0)

Inserts a note

Parameters

  • text – initial text for this note

  • target – where the arrow should point

  • position – where the text is positioned

  • AnnotateThis – key to what this annotation is annotating

  • pView – pointer to the view

  • layer_key – style segment for this note

  • bg_type – one of four stock background types

  • useArrow – sets the visibility of the arrow

  • key_path – is the key path returned by HC_Show_Selection_Original_Keys

  • key_path_length – is the length returned by HC_Show_Selection_Original_Keys

Returns

key to the root of the note segment tree

virtual void MoveText(HPoint position)

Move the text and measuring line to position and leave dashed leader lines to the original points a and b

virtual void MoveText(HPoint A, HPoint B)

Sets the start and end point of the measurement and places the text half way between.

virtual void SetNote(HC_KEY noteskey, HBaseView *view)

Sets the annotation class to refer to the annotation with key noteskey. Before passing a key to this function be sure that IsMeasurement return true on that key.

Public Static Functions

static bool IsMeasurement(HC_KEY key)

Returns true if the key passed in is a measurement annotation key

static void drawLineCallbackDummy(HIC_Rendition const *rendition, int count, HIC_DC_Point p[])