HUtilityAnnotationMeasure

class HUtilityAnnotationMeasure

The HUtilityAnnotationMeasure class defines and manages annotations.

This class simplified the creation of measurement annotations.

Inherits from: HUtilityAnnotation

Methods

virtual char const *HUtilityAnnotationMeasure::GetType()

virtual

Returns “HUtilityAnnotationMeasure”

virtual HC_KEY HUtilityAnnotationMeasure::Insert(HPoint target, HPoint position, HC_KEY AnnotateThis, HBaseView *pView, HC_KEY layer_key = INVALID_KEY, int bg_type = BG_QUAD, bool useArrow = true, HC_KEY *key_path = (HC_KEY*)0, int key_path_length = 0)

virtual

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 HUtilityAnnotationMeasure::Insert(char const *text, HPoint target, HPoint position, HC_KEY AnnotateThis, HBaseView *pView, HC_KEY layer_key = INVALID_KEY, int bg_type = BG_QUAD, bool useArrow = true, HC_KEY *key_path = (HC_KEY*)0, int key_path_length = 0)

virtual

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 HUtilityAnnotationMeasure::InsertWithEncoding(unsigned short const *text, HPoint target, HPoint position, HC_KEY AnnotateThis, HBaseView *pView, HC_KEY layer_key = INVALID_KEY, int bg_type = BG_QUAD, bool useArrow = true, HC_KEY *key_path = (HC_KEY*)0, int key_path_length = 0)

virtual

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 HUtilityAnnotationMeasure::MoveText(HPoint position)

virtual

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

virtual void HUtilityAnnotationMeasure::MoveText(HPoint A, HPoint B)

virtual

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

virtual void HUtilityAnnotationMeasure::SetNote(HC_KEY noteskey, HBaseView *view)

virtual

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.

static bool HUtilityAnnotationMeasure::IsMeasurement(HC_KEY key)

static

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

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

static

static void HUtilityAnnotationMeasure::mid_point(HPoint &A, HPoint &B, HPoint &mid)

protected static

void HUtilityAnnotationMeasure::MoveTextCommon()

private

Variables

HPoint HUtilityAnnotationMeasure::m_pnt_a1

protected

HPoint HUtilityAnnotationMeasure::m_pnt_b1

protected

HPoint HUtilityAnnotationMeasure::m_pnt_a2

protected

HPoint HUtilityAnnotationMeasure::m_pnt_b2

protected

HPoint HUtilityAnnotationMeasure::m_position

protected