Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HUtilityAnnotationMeasure Class Reference

The HUtilityAnnotationMeasure class defines and manages annotations. More...

#include <HUtilityAnnotationMeasure.h>

List of all members.

Public Member Functions

virtual char const * GetType ()
virtual HC_KEY 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 HC_KEY 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 HC_KEY 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 void MoveText (HPoint position)
virtual void MoveText (HPoint A, HPoint B)
virtual void SetNote (HC_KEY noteskey, HBaseView *view)

Static Public Member Functions

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

Static Protected Member Functions

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

Protected Attributes

HPoint m_pnt_a1
HPoint m_pnt_a2
HPoint m_pnt_b1
HPoint m_pnt_b2
HPoint m_position

Detailed Description

The HUtilityAnnotationMeasure class defines and manages annotations.

This class simplified the creation of measurement annotations.


Member Function Documentation

virtual char const* HUtilityAnnotationMeasure::GetType ( ) [inline, virtual]

Returns "HUtilityAnnotationMeasure"

Reimplemented from HUtilityAnnotation.

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:
targetwhere the arrow should point
positionwhere the text is positioned
AnnotateThiskey to what this annotation is annotating
pViewpointer to the view
layer_keystyle segment for this note
bg_typeone of four stock background types
useArrowsets the visibility of the arrow
key_pathis the key path returned by HC_Show_Selection_Original_Keys
key_path_lengthis the length returned by HC_Show_Selection_Original_Keys
Returns:
key to the root of the note segment tree

Reimplemented from HUtilityAnnotation.

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:
textinitial text for this note
targetwhere the arrow should point
positionwhere the text is positioned
AnnotateThiskey to what this annotation is annotating
pViewpointer to the view
layer_keystyle segment for this note
bg_typeone of four stock background types
useArrowsets the visibility of the arrow
key_pathis the key path returned by HC_Show_Selection_Original_Keys
key_path_lengthis the length returned by HC_Show_Selection_Original_Keys
Returns:
key to the root of the note segment tree

Reimplemented from HUtilityAnnotation.

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:
textinitial text for this note
targetwhere the arrow should point
positionwhere the text is positioned
AnnotateThiskey to what this annotation is annotating
pViewpointer to the view
layer_keystyle segment for this note
bg_typeone of four stock background types
useArrowsets the visibility of the arrow
key_pathis the key path returned by HC_Show_Selection_Original_Keys
key_path_lengthis the length returned by HC_Show_Selection_Original_Keys
Returns:
key to the root of the note segment tree

Reimplemented from HUtilityAnnotation.

static bool HUtilityAnnotationMeasure::IsMeasurement ( HC_KEY  key) [static]

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

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.

Reimplemented from HUtilityAnnotation.


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