Documentation
 All Classes Functions Variables Properties
MST::Imaging::Annotations::MSTAnnotation Class Reference

#include <Annotation.h>

Inheritance diagram for MST::Imaging::Annotations::MSTAnnotation:
MST::Imaging::Annotations::MultiPointAnnotation MST::Imaging::Annotations::SinglePointAnnotation MST::Imaging::Annotations::TwoPointAnnotation MST::Imaging::Annotations::Angle MST::Imaging::Annotations::Curve MST::Imaging::Annotations::Pencil MST::Imaging::Annotations::PolyLine MST::Imaging::Annotations::Point MST::Imaging::Annotations::CrossProduct MST::Imaging::Annotations::Line MST::Imaging::Annotations::Rectangle

Public Member Functions

 MSTAnnotation (Pen^ pen, MSTAnnotationPage^ page)
 Constructor of a class. More...
 
void DrawPoints (Graphics^ g)
 Draw Selection points of annotation. More...
 
array< PointF >^ GetNormalPoints ()
 Gives points array of annotation without any operation such as without rotation,zooming,flip etc. More...
 
virtual void Save (XmlDocument^ writer, XmlElement^ element)
 use to save annotation in XML. More...
 
virtual void Load (XmlElement^ element)
 use to load annotation from XML. More...
 
void FlipGraphicsPath (GraphicsPath^ gp, float Width, float Height, bool bHorz, bool bVert)
 Flips annotation's graphics path. More...
 
void DrawString (Graphics^ g, String^ text, Point location)
 Draw String. More...
 
void DrawScale (GraphicsPath^ g, PointF pt1, PointF pt2, float distance)
 
virtual void Move (int cx, int cy)
 Use to move annotation. More...
 
virtual bool HitTest (PointF pt)
 use to check point lies in annotation or not More...
 
virtual bool IntersectsRect (System::Drawing::Rectangle rect)
 use to check annotation lies in rectangle or not. More...
 
virtual void ApplyMatrix (Matrix^ matrix)
 use to apply matrix on graphicsPath. More...
 
virtual Int16 GetPointIndex (PointF pt)
 use to get index of point. More...
 
virtual void Draw (Graphics^ g, array< PointF >^ptArr, bool bShowSelection)
 Used to draw annotations. More...
 
virtual void Draw (GraphicsPath^ gp, array< PointF >^ptArr)
 
void Burn (Graphics^ g)
 

Static Protected Member Functions

static bool IsLineIntersectsRect (array< PointF >^pts, System::Drawing::Rectangle rect)
 use to check line intersect with rectangle or not. More...
 
static double getdistance (PointF start, PointF end, float fPixelWidth, float fPixelHeight)
 

Protected Attributes

Pen^ m_pen
 
array< PointF >^ m_ptArr
 
MSTAnnotationPagem_pPage
 
bool m_bSelected
 

Properties

Type AnnotationType [get]
 Get type of annotation.
 
Color BorderColor [get, set]
 Get or Set annotation's border color.
 
Int32 BorderWidth [get, set]
 Get or Set annotation's border width.
 
bool Selected [get, set]
 Get or Set annotation's selection.
 
array< PointF >^ Points [get]
 Get Points of annotation. More...
 
PointF Points[Int16] [get, set]
 
System::Drawing::Drawing2D::GraphicsPath^  graphicsPath [get]
 Get annotation's graphicsPath.
 
array< RectangleF >^ PointRect [get]
 Get rectangles arround points.
 
Int16 PointsCount [get]
 Get total number of annotation's points.
 

Detailed Description

This is an abstract class and also base class for all type of annotation classes.

Constructor & Destructor Documentation

MST::Imaging::Annotations::MSTAnnotation::MSTAnnotation ( Pen^  pen,
MSTAnnotationPage page 
)

Constructor of a class.

Parameters
penused to draw annotaion.
pageDocument page which contains annotations.

Member Function Documentation

void MST::Imaging::Annotations::MSTAnnotation::ApplyMatrix ( Matrix^  matrix)
virtual

use to apply matrix on graphicsPath.

Parameters
matrixIt is matrix which apply on graphicpath
void MST::Imaging::Annotations::MSTAnnotation::Draw ( Graphics^  g,
array< PointF >^  ptArr,
bool  bShowSelection 
)
virtual
void MST::Imaging::Annotations::MSTAnnotation::DrawPoints ( Graphics^  g)

Draw Selection points of annotation.

Parameters
gDraw selection points.
void MST::Imaging::Annotations::MSTAnnotation::DrawString ( Graphics^  g,
String^  text,
Point  location 
)
inline

Draw String.

Parameters
ggraphic which is used to draw string.
textString to draw.
locationspecifies the upper-left corner of the drawn text.
void MST::Imaging::Annotations::MSTAnnotation::FlipGraphicsPath ( GraphicsPath^  gp,
float  Width,
float  Height,
bool  bHorz,
bool  bVert 
)

Flips annotation's graphics path.

Parameters
gpAnnotation's graphic path.
Widthwidth of page which contain annotation.
Heightheight of page which contain annotation.
bHorzif bhorz is true then path flip's horizontally.
bVertif bVert is true then path flip's vertically.
array< PointF > MST::Imaging::Annotations::MSTAnnotation::GetNormalPoints ( )

Gives points array of annotation without any operation such as without rotation,zooming,flip etc.

Returns
Points array of annotation.
Int16 MST::Imaging::Annotations::MSTAnnotation::GetPointIndex ( PointF  pt)
virtual

use to get index of point.

Parameters
ptIt is point.

Reimplemented in MST::Imaging::Annotations::CrossProduct.

bool MST::Imaging::Annotations::MSTAnnotation::HitTest ( PointF  pt)
virtual

use to check point lies in annotation or not

Parameters
ptThe point value to hit test against. .
Returns
return true if HitTest successfull else false.

Reimplemented in MST::Imaging::Annotations::MultiPointAnnotation.

bool MST::Imaging::Annotations::MSTAnnotation::IntersectsRect ( System::Drawing::Rectangle  rect)
virtual

use to check annotation lies in rectangle or not.

Parameters
rectIt is rectangle.
Returns
return true if successfull else false.

Reimplemented in MST::Imaging::Annotations::Angle, MST::Imaging::Annotations::CrossProduct, and MST::Imaging::Annotations::Line.

static bool MST::Imaging::Annotations::MSTAnnotation::IsLineIntersectsRect ( array< PointF >^  pts,
System::Drawing::Rectangle  rect 
)
staticprotected

use to check line intersect with rectangle or not.

Parameters
ptsannotation points array.
rectrectangale against which intersection is checked.
Returns
true if successfull else false.
void MST::Imaging::Annotations::MSTAnnotation::Load ( XmlElement^  element)
virtual
void MST::Imaging::Annotations::MSTAnnotation::Move ( int  cx,
int  cy 
)
virtual

Use to move annotation.

Parameters
cxChange in X cordinate.
cyChange in Y cordinate.

Reimplemented in MST::Imaging::Annotations::Point.

bool MST::Imaging::Annotations::MSTAnnotation::Save ( XmlDocument^  writer,
XmlElement^  element 
)
virtual

Property Documentation

PointF MST::Imaging::Annotations::MSTAnnotation::Points[Int16]
get

Get Points of annotation.

Get or Set annotation's point.


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