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

#include <HUtilityAnnotationMeasure.h>

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)
 
- Public Member Functions inherited from HUtilityAnnotation
virtual void AddChar (char the_char)
 
virtual void AddChar (unsigned short the_char)
 
virtual HC_KEY GetBackgroundSegmentKey ()
 
virtual HPoint GetFacing () const
 
virtual HC_KEY GetKey ()
 
virtual bool GetOnTop ()
 
virtual void GetText (char *text, int &length)
 
virtual int GetTextLength ()
 
virtual void GetTextWithEncoding (unsigned short *text, int &length)
 
virtual HPoint GetUp () const
 
virtual void MoveText (HPoint const &pos, HCamera const *camera=0)
 
virtual void MoveText (HPoint const &tar, HPoint const &pos, HCamera const *camera=0)
 
virtual void Resize (int include_count, HC_KEY include_keys[], HC_KEY view_key)
 
virtual void Resize (HC_KEY include_keys, HC_KEY view_key)
 
virtual void SetBackgroundType (long type)
 
virtual void SetColor (char const *color)
 
virtual void SetEdgeWeight (float weight)
 
virtual void SetExtents (int xpixels, int ypixels, HC_KEY view_key)
 
virtual void SetFacePattern (char const *pattern)
 
virtual void SetLinePattern (char const *pattern)
 
virtual void SetLineWeight (float weight)
 
virtual void SetNote (HC_KEY noteskey, HC_KEY view_key)
 
virtual void SetOnTop (bool t)
 
virtual void SetText (char const *text)
 
virtual void SetTextFont (char const *font)
 
virtual void SetTextWithEncoding (unsigned short const *text)
 
virtual void ShowPosition (HPoint &p)
 
virtual void ShowPosition (float *x, float *y, float *z)
 
virtual void ShowTarget (HPoint &p)
 
virtual void ShowTarget (float *x, float *y, float *z)
 
virtual void UnSetExtents ()
 

Static Public Member Functions

static void drawLineCallbackDummy (HIC_Rendition const *rendition, int count, HIC_DC_Point p[])
 
static bool IsMeasurement (HC_KEY key)
 
- Static Public Member Functions inherited from HUtilityAnnotation
static void ChangeAllFonts (HBaseView *view, char const *const font, HC_KEY seg_key=INVALID_KEY)
 
static void drawLineCallback (HIC_Rendition const *rendition, int count, HIC_DC_Point p[])
 
static void drawLineCallbackClip (HIC_Rendition const *rendition, int count, HIC_DC_Point p[])
 
static void drawMarkerCallback (HIC_Rendition const *rendition, HIC_DC_Point *p)
 
static HC_KEY GetKey (HC_KEY)
 
static bool IsAnnotation (HC_KEY key)
 
static bool IsNote (HC_KEY noteskey)
 
static void recursive_resize (HC_KEY seg_key, int include_count, HC_KEY include_keys[], HC_KEY view_key)
 
static void WindowResizeCallback (int signal, void *signal_data, void *user_data)
 

Static Protected Member Functions

static void mid_point (HPoint &A, HPoint &B, HPoint &mid)
 
- Static Protected Member Functions inherited from HUtilityAnnotation
static int Clip_Line (HIC_DC_Point *p, HIC_DC_Point *po, int top, int left, int bottom, int right)
 
static int Clip_Line_Inverse (HIC_DC_Point *p, HIC_DC_Point *po, int top, int left, int bottom, int right)
 

Protected Attributes

HPoint m_pnt_a1
 
HPoint m_pnt_a2
 
HPoint m_pnt_b1
 
HPoint m_pnt_b2
 
HPoint m_position
 
- Protected Attributes inherited from HUtilityAnnotation
HC_KEY m_MyKey
 
HC_KEY m_MyTextKey
 
HPoint m_position
 
HPoint m_target
 

Additional Inherited Members

- Static Protected Attributes inherited from HUtilityAnnotation
static int g_height
 
static HC_KEY g_segmentkey
 
static int g_width
 

Detailed Description

The HUtilityAnnotationMeasure class defines and manages annotations.

This class simplified the creation of measurement annotations.

Member Function Documentation

◆ GetType()

virtual char const* HUtilityAnnotationMeasure::GetType ( )
inlinevirtual

Returns "HUtilityAnnotationMeasure"

Reimplemented from HUtilityAnnotation.

◆ Insert() [1/2]

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.

◆ Insert() [2/2]

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.

◆ InsertWithEncoding()

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.

◆ IsMeasurement()

static bool HUtilityAnnotationMeasure::IsMeasurement ( HC_KEY  key)
static

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

◆ MoveText() [1/2]

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

◆ MoveText() [2/2]

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.

◆ SetNote()

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: