hdicoreAnnotate.h File Reference

Header file for drawing Illustrator annotations during Annotator object callbacks. More...

#include <vector>
#include "hdicoreAngle.h"
#include "hdicoreColor.h"
#include "hdicoreRect.h"
#include "hdicoreSegPoint.h"
#include "hdicoreTypes.h"

Include dependency graph for hdicoreAnnotate.h:

Classes
struct	hdi::core::annotate::TextConfig

Namespaces
namespace	hdi::core::annotate
	Organizes all annotation drawing functions into one namespace, each of which will only perform their drawing task(s) if called from within an Annotator callback.

Typedefs
typedef std::vector< Point >	hdi::core::annotate::PointVector
typedef std::vector< SegPoint >	hdi::core::annotate::SegPointVector

Enumerations
enum	hdi::core::annotate::FontType {   DefaultFont , DialogFont , BoldDialogFont , ItalicDialogFont ,   BoldItalicDialogFont , PanelFont , BoldPanelFont , ItalicPanelFont ,   BoldItalicPanelFont }
	Describes the type of font to use when annotating text; see also setFontType()

Functions
bool	hdi::core::annotate::line (const Point &start_, const Point &end_)
	Draws a line with the given end points.
bool	hdi::core::annotate::dashedLine (const Point &start_, const Point &end_, const double dash_, const double gap_)
	Draws a dashed line with the given end points and dash specs.
bool	hdi::core::annotate::rect (const Rect &rect_, const bool fill_=false)
	Draws a rectangle with the given coordinates and fill.
bool	hdi::core::annotate::ellipse (const Rect &bounds_, const bool fill_=false)
	Draws an ellipse within the given rectangular bounds.
bool	hdi::core::annotate::polygon (const PointVector &points_, const bool fill_=false)
	Draws a polygon constructed of the given points.
bool	hdi::core::annotate::bezier (const SegPointVector &segPts_, const bool fill_=false)
	Draws a bezier from the given segment points.
bool	hdi::core::annotate::image (const int16_t imgID_, const Point &pt_)
	Draws an image at the given point.
bool	hdi::core::annotate::image (const byte *const png_, const uint32_t pngSize_, const Point &pt_)
	Draws an image from its raw PNG data at the given point, scaled to the document DPI.
bool	hdi::core::annotate::imageUnscaled (const byte *const png_, const uint32_t pngSize_, const Point &pt_)
	Draws an image from its raw PNG data at the given point, unscaled.
bool	hdi::core::annotate::text (const std::string &text_, const Point &pt_, const TextConfig &config_=TextConfig())
	Draws text with the current font and left justification.
Color	hdi::core::annotate::color ()
	Gets the current annotation color.
void	hdi::core::annotate::setColor (const Color &color_)
	Sets the current annotation color.
double	hdi::core::annotate::lineWidth ()
	Gets the line width used when drawing paths or unfilled objects.
void	hdi::core::annotate::setLineWidth (const double width_)
	Sets the line width used when drawing paths or unfilled objects.
void	hdi::core::annotate::setFont (const Font &font_)
	Sets the current font for annotation text art.
void	hdi::core::annotate::setFontSize (const double size_)
	Sets the current font size for annotation text art.
std::unique_ptr< Font >	hdi::core::annotate::font ()
	Gets the current font for annotation text art.
double	hdi::core::annotate::fontSize ()
	Gets the current font size for annotation text art.
void	hdi::core::annotate::setFontType (const FontType font_)
	Sets the current font for annotation text art.
Size	hdi::core::annotate::textSize (const std::string &text_, const TextConfig &config_=TextConfig())
	Gets the bounds for the given text at the origin.
void	hdi::core::annotate::invalidateAll ()
	Loops through all views of the current document and invalidates their annotations.

Detailed Description

Header file for drawing Illustrator annotations during Annotator object callbacks.

Copyright

Hot Door, Inc. 2010-2019