#include <opennurbs_annotationbase.h>

Inheritance diagram for ON_Annotation:

Public Member Functions
bool	Alternate (const ON_DimStyle *parent_style) const
	Additional measurement display toggle. More...

bool	AlternateBelow (const ON_DimStyle *parent_style) const

ON_DimStyle::LengthDisplay	AlternateDimensionLengthDisplay (const ON_DimStyle *parent_style) const

ON::LengthUnitSystem	AlternateDimensionLengthDisplayUnit (const ON_DimStyle *parent_style, unsigned int model_sn) const
	Parameters: model_sn - 0, a model serial number, or ON_UNSET_UINT_INDEX to use the dimstyle's ModelSerialNumber() value. Returns Unit system for dimension length display. If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits and model_sn > 0, then the value of ON::LengthUnitSystemFromModelSerialNumber(model_sn) is returned. If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits and model_sn == 0, then ON::LengthUnitSystem::None is returned. More...

double	AlternateLengthFactor (const ON_DimStyle *parent_style) const
	Distance scale factor for alternate display. More...

int	AlternateLengthResolution (const ON_DimStyle *parent_style) const
	Display resolution for alternate length measurements. More...

const wchar_t *	AlternatePrefix (const ON_DimStyle *parent_style) const
	Dimension alternate prefix text. More...

double	AlternateRoundOff (const ON_DimStyle *parent_style) const

const wchar_t *	AlternateSuffix (const ON_DimStyle *parent_style) const
	Dimension alternate suffix text. More...

int	AlternateToleranceResolution (const ON_DimStyle *parent_style) const

ON_DimStyle::suppress_zero	AlternateZeroSuppress (const ON_DimStyle *parent_style) const

ON_DimStyle::angle_format	AngleFormat (const ON_DimStyle *parent_style) const
	Angle units - Degrees, Degrees-Minutes-Seconds, Radians. More...

int	AngleResolution (const ON_DimStyle *parent_style) const
	Display resolution for angle measurements. More...

double	AngleRoundOff (const ON_DimStyle *parent_style) const

ON_DimStyle::suppress_zero	AngleZeroSuppress (const ON_DimStyle *parent_style) const

int	ArcLengthSymbol (const ON_DimStyle *parent_style) const

ON_UUID	ArrowBlockId1 (const ON_DimStyle *parent_style) const

ON_UUID	ArrowBlockId2 (const ON_DimStyle *parent_style) const

double	ArrowSize (const ON_DimStyle *parent_style) const
	Arrow size. More...

ON_Arrowhead::arrow_type	ArrowType1 (const ON_DimStyle *parent_style) const

ON_Arrowhead::arrow_type	ArrowType2 (const ON_DimStyle *parent_style) const

double	BaselineSpacing (const ON_DimStyle *parent_style) const

double	CenterMarkSize (const ON_DimStyle *parent_style) const
	Centermark size. More...

ON_DimStyle::centermark_style	CenterMarkStyle (const ON_DimStyle *parent_style) const
	Centermark style. More...

void	ClearFieldOverride (ON_DimStyle::field field)

void	ClearOverrideDimensionStyle ()
	Removes any override dimension style that is present. More...

void	ClearText () const

ON_DimStyle::LengthDisplay	DimensionLengthDisplay (const ON_DimStyle *parent_style) const

ON::LengthUnitSystem	DimensionLengthDisplayUnit (const ON_DimStyle *parent_style, unsigned int model_sn) const
	Parameters: model_sn - 0, a model serial number, or ON_UNSET_UINT_INDEX to use the dimstyle's ModelSerialNumber() value. Returns Unit system for dimension length display. If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits and model_sn > 0, then the value of ON::LengthUnitSystemFromModelSerialNumber(model_sn) is returned. If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits and model_sn == 0, then ON::LengthUnitSystem::None is returned. More...

const ON_DimStyle &	DimensionStyle (const ON_DimStyle &parent_dimstyle) const

const ON_DimStyle &	DimensionStyle (const ON_DimStyle &parent_dimstyle, bool bForceOverrideUpdate) const

ON_UUID	DimensionStyleId () const

double	DimExtension (const ON_DimStyle *parent_style) const
	Extension of dimension line past extension lines. More...

ON_DimStyle::ContentAngleStyle	DimRadialTextAngleStyle (const ON_DimStyle *parent_style) const

ON_DimStyle::TextLocation	DimRadialTextLocation (const ON_DimStyle *parent_style) const
	The location of text relative to the dimension line in radial dimensions. More...

ON::TextOrientation	DimRadialTextOrientation (const ON_DimStyle *parent_style) const

double	DimScale (const ON_DimStyle *parent_style) const

ON_SHA1_Hash	DimStyleTextPositionPropertiesHash () const

ON_DimStyle::ContentAngleStyle	DimTextAngleStyle (const ON_DimStyle *parent_style) const

ON_DimStyle::TextLocation	DimTextLocation (const ON_DimStyle *parent_style) const
	The location of text relative to the dimension line in linear, angular, and ordinate dimensions. More...

ON::TextOrientation	DimTextOrientation (const ON_DimStyle *parent_style) const

bool	DrawForward (const ON_DimStyle *parent_style) const

bool	DrawTextMask (const ON_DimStyle *parent_style) const
	Determines whether or not to draw a Text Mask. More...

bool	EqualTextPositionProperties (const class ON_DimStyle *dimstyle) const

double	ExtensionLineExtension (const ON_DimStyle *parent_style) const
	These next several functions are to set overrides on individual annotation objects. More...

double	ExtensionLineOffset (const ON_DimStyle *parent_style) const
	Extension line offset. More...

bool	FieldIsOverridden (ON_DimStyle::field field) const

double	FixedExtensionLength (const ON_DimStyle *parent_style) const

bool	FixedExtensionLengthOn (const ON_DimStyle *parent_style) const

const class ON_Font &	Font (const ON_DimStyle *parent_style) const

const class ON_Font &	FontCharacteristics (const ON_DimStyle *parent_style) const

const bool	FontSubstituted (const ON_DimStyle *parent_style) const

double	FormattingRectangleWidth () const
	FormattingRectangleWidth is a width set by text wrapping. It's in model units. More...

void	GetAlignment (ON::TextHorizontalAlignment &horz, ON::TextVerticalAlignment &vert) const

virtual bool	GetAnnotationBoundingBox (const ON_Viewport vp, const ON_DimStyle dimstyle, double dimscale, double boxmin, double boxmax, bool bGrow=false) const =0

bool	GetText3dCorners (ON_3dPoint corners[4]) const

bool	GetTextGlyphContours (const ON_Viewport vp, const ON_DimStyle dimstyle, bool bApplyDimStyleDimScale, bool bSingleStrokeFont, ON_ClassArray< ON_ClassArray< ON_SimpleArray< ON_Curve * > > > &text_contours) const

virtual bool	GetTextXform (const ON_Viewport vp, const ON_DimStyle dimstyle, double dimscale, ON_Xform &text_xform_out) const =0

bool	HasDimensionStyleOverrides () const
	Quickly check if this annotation object has style overrides applied. More...

const ON_2dVector	HorizontalDirection () const

bool	IsOverrideDimStyleCandidate (const ON_DimStyle *override_style_candidate, bool bRequireSetOverrides) const
	A valid override dimstyle candidate has all of the following properties. override_style_candidate != nullptr. IsDeleted() = false; Id() = ON_nil_uuid; Name() is empty. Index() = ON_ModelComponent::Unset.Index() bRequireSetOverrides is false or HasOverrides() returns true. More...

bool	IsOverrideStylePointer (const ON_DimStyle *ptr) const

bool	IsValid (class ON_TextLog *text_log=nullptr) const override
	Tests an object to see if its data members are correctly initialized. More...

ON_UUID	LeaderArrowBlockId (const ON_DimStyle *parent_style) const

double	LeaderArrowSize (const ON_DimStyle *parent_style) const
	Arrow size. More...

ON_Arrowhead::arrow_type	LeaderArrowType (const ON_DimStyle *parent_style) const

double	LeaderContentAngleDegrees (const ON_DimStyle *parent_style) const

double	LeaderContentAngleRadians (const ON_DimStyle *parent_style) const

ON_DimStyle::ContentAngleStyle	LeaderContentAngleStyle (const ON_DimStyle *parent_style) const

ON_DimStyle::leader_curve_type	LeaderCurveType (const ON_DimStyle *parent_style) const

bool	LeaderHasLanding (const ON_DimStyle *parent_style) const

double	LeaderLandingLength (const ON_DimStyle *parent_style) const

ON::TextHorizontalAlignment	LeaderTextHorizontalAlignment (const ON_DimStyle *parent_style) const

ON::TextOrientation	LeaderTextOrientation (const ON_DimStyle *parent_style) const

ON::TextVerticalAlignment	LeaderTextVerticalAlignment (const ON_DimStyle *parent_style) const

double	LengthFactor (const ON_DimStyle *parent_style) const
	Scale factor for displayed distances. More...

int	LengthResolution (const ON_DimStyle *parent_style) const
	Display resolution for distance measurements. More...

double	MaskBorder (const ON_DimStyle *parent_style) const

ON_Color	MaskColor (const ON_DimStyle *parent_style) const

ON_TextMask::MaskType	MaskFillType (const ON_DimStyle *parent_style) const
	Determines where to get the color to draw a Text Mask. More...

ON::object_type	ObjectType () const override
	Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on. More...

const ON_wString	PlainText () const

const ON_wString	PlainTextWithFields () const

const ON_Plane &	Plane () const

const wchar_t *	Prefix (const ON_DimStyle *parent_style) const
	Dimension prefix text. More...

bool	ReplaceTextString (const wchar_t RtfString, const ON_DimStyle dimstyle)

const ON_wString	RichText () const

double	RoundOff (const ON_DimStyle *parent_style) const

const wchar_t *	RtfText () const

void	SetAlignment (ON::TextHorizontalAlignment horz, ON::TextVerticalAlignment vert)

void	SetAlternate (const ON_DimStyle *parent_style, bool)

void	SetAlternateBelow (const ON_DimStyle *parent_style, bool below)

void	SetAlternateDimensionLengthDisplay (const ON_DimStyle *parent_style, ON_DimStyle::LengthDisplay length_display)

void	SetAlternateLengthFactor (const ON_DimStyle *parent_style, double)

void	SetAlternateLengthResolution (const ON_DimStyle *parent_style, int)

void	SetAlternatePrefix (const ON_DimStyle parent_style, const wchar_t )

void	SetAlternateRoundOff (const ON_DimStyle *parent_style, double r)

void	SetAlternateSuffix (const ON_DimStyle parent_style, const wchar_t )

void	SetAlternateToleranceResolution (const ON_DimStyle *parent_style, int r)

void	SetAlternateZeroSuppress (const ON_DimStyle *parent_style, ON_DimStyle::suppress_zero s)

void	SetAngleFormat (const ON_DimStyle *parent_style, ON_DimStyle::angle_format format)

void	SetAngleResolution (const ON_DimStyle *parent_style, int r)

void	SetAngleRoundOff (const ON_DimStyle *parent_style, double r)

void	SetAngleZeroSuppress (const ON_DimStyle *parent_style, ON_DimStyle::suppress_zero s)

bool	SetAnnotationBold (bool bold, const ON_DimStyle *dimstyle)

bool	SetAnnotationFacename (bool set_or_clear, const wchar_t facename, const ON_DimStyle parent_style)

bool	SetAnnotationItalic (bool italic, const ON_DimStyle *dimstyle)

bool	SetAnnotationUnderline (bool underline, const ON_DimStyle *dimstyle)

void	SetArcLengthSymbol (const ON_DimStyle *parent_style, int m)

void	SetArrowBlockId1 (const ON_DimStyle *parent_style, ON_UUID id)

void	SetArrowBlockId2 (const ON_DimStyle *parent_style, ON_UUID id)

void	SetArrowSize (const ON_DimStyle *parent_style, double d)

void	SetArrowType1 (const ON_DimStyle *parent_style, ON_Arrowhead::arrow_type)

void	SetArrowType1And2 (const ON_DimStyle *parent_style, ON_Arrowhead::arrow_type)

void	SetArrowType2 (const ON_DimStyle *parent_style, ON_Arrowhead::arrow_type)

void	SetBaselineSpacing (const ON_DimStyle *parent_style, double spacing)

void	SetCenterMarkSize (const ON_DimStyle *parent_style, double d)

void	SetCenterMarkStyle (const ON_DimStyle *parent_style, ON_DimStyle::centermark_style style)

void	SetDimensionLengthDisplay (const ON_DimStyle *parent_style, ON_DimStyle::LengthDisplay length_display)

void	SetDimensionStyleId (ON_UUID dimstyle_id)

void	SetDimensionStyleId (const class ON_DimStyle &dim_style)

void	SetDimensionStyleIdForExperts (ON_UUID dimstyle_id, bool bKeepOverrides)
	Set the id of the main (parent) dimstyle used by this annotation object and allow an expert user to control what happens to style override settings in cases where id collisions occur and ids need to be changed. More...

void	SetDimExtension (const ON_DimStyle *parent_style, const double e)

void	SetDimRadialTextAngleStyle (const ON_DimStyle *parent_style, ON_DimStyle::ContentAngleStyle style)

void	SetDimRadialTextLocation (const ON_DimStyle *parent_style, ON_DimStyle::TextLocation dim_text_location)

void	SetDimRadialTextOrientation (const ON_DimStyle *parent_style, ON::TextOrientation orientation)

void	SetDimScale (const ON_DimStyle *parent_style, double scale)

void	SetDimTextAngleStyle (const ON_DimStyle *parent_style, ON_DimStyle::ContentAngleStyle style)

void	SetDimTextLocation (const ON_DimStyle *parent_style, ON_DimStyle::TextLocation dim_text_location)

void	SetDimTextOrientation (const ON_DimStyle *parent_style, ON::TextOrientation orientation)

void	SetDrawForward (const ON_DimStyle *parent_style, bool drawforward)

void	SetDrawTextMask (const ON_DimStyle *parent_style, bool bDraw)

void	SetExtensionLineExtension (const ON_DimStyle *parent_style, double d)

void	SetExtensionLineOffset (const ON_DimStyle *parent_style, double d)

void	SetFixedExtensionLength (const ON_DimStyle *parent_style, double l)

void	SetFixedExtensionLengthOn (const ON_DimStyle *parent_style, bool on)

void	SetFont (const ON_DimStyle *parent_style, const class ON_Font &font_characteristics)
	Set the font used to render text. More...

void	SetFormattingRectangleWidth (double width)

void	SetHorizontalDirection (ON_2dVector)

void	SetLeaderArrowBlockId (const ON_DimStyle *parent_style, ON_UUID id)

void	SetLeaderArrowSize (const ON_DimStyle *parent_style, double d)

void	SetLeaderArrowType (const ON_DimStyle *parent_style, ON_Arrowhead::arrow_type)

void	SetLeaderContentAngleDegrees (const ON_DimStyle *parent_style, double angle_degrees)

void	SetLeaderContentAngleRadians (const ON_DimStyle *parent_style, double angle_radians)

void	SetLeaderContentAngleStyle (const ON_DimStyle *parent_style, ON_DimStyle::ContentAngleStyle style)

void	SetLeaderCurveType (const ON_DimStyle *parent_style, ON_DimStyle::leader_curve_type type)

void	SetLeaderHasLanding (const ON_DimStyle *parent_style, bool landing)

void	SetLeaderLandingLength (const ON_DimStyle *parent_style, double length)

void	SetLeaderTextHorizontalAlignment (const ON_DimStyle *parent_style, ON::TextHorizontalAlignment halign)

void	SetLeaderTextOrientation (const ON_DimStyle *parent_style, ON::TextOrientation orientation)

void	SetLeaderTextVerticalAlignment (const ON_DimStyle *parent_style, ON::TextVerticalAlignment style)

void	SetLengthFactor (const ON_DimStyle *parent_style, double)

void	SetLengthResolution (const ON_DimStyle *parent_style, int r)

void	SetMaskBorder (const ON_DimStyle *parent_style, double offset)

void	SetMaskColor (const ON_DimStyle *parent_style, ON_Color color)

void	SetMaskFillType (const ON_DimStyle *parent_style, ON_TextMask::MaskType source)

bool	SetOverrideDimensionStyle (ON_DimStyle *&override_style) const

bool	SetOverrideDimensionStyle (const ON_DimStyle *override_style_candidate, bool bRequireSetOverrides)
	If this->IsOverrideDimStyleCandidate(override_style_candidate,bRequireSetOverrides) is true, then a managed copy of override_style_candidate is set as an override. More...

void	SetPlane (const ON_Plane &plane)

void	SetPrefix (const ON_DimStyle parent_style, const wchar_t )

void	SetRoundOff (const ON_DimStyle *parent_style, double r)

void	SetSignedOrdinate (const ON_DimStyle *parent_style, bool allowsigned)

void	SetStackFractionFormat (const ON_DimStyle *parent_style, ON_DimStyle::stack_format f)

void	SetStackHeightScale (const ON_DimStyle *parent_style, double f)

void	SetSuffix (const ON_DimStyle parent_style, const wchar_t )

void	SetSuppressArrow1 (const ON_DimStyle *parent_style, bool s)

void	SetSuppressArrow2 (const ON_DimStyle *parent_style, bool s)

void	SetSuppressExtension1 (const ON_DimStyle *parent_style, bool b)

void	SetSuppressExtension2 (const ON_DimStyle *parent_style, bool b)

void	SetText (ON_TextContent *&text) const

void	SetTextGap (const ON_DimStyle *parent_style, double gap)

void	SetTextHeight (const ON_DimStyle *parent_style, double height)

void	SetTextHorizontalAlignment (const ON_DimStyle *parent_style, ON::TextHorizontalAlignment halign)

void	SetTextMask (const ON_DimStyle *parent_style, const ON_TextMask &mask)

void	SetTextMoveLeader (const ON_DimStyle *parent_style, int m)

void	SetTextOrientation (const ON_DimStyle *parent_style, ON::TextOrientation orientation)

virtual void	SetTextRotationDegrees (double rotation)

virtual void	SetTextRotationRadians (double rotation)

void	SetTextUnderlined (const ON_DimStyle *parent_style, bool underlined)

void	SetTextVerticalAlignment (const ON_DimStyle *parent_style, ON::TextVerticalAlignment style)

void	SetToleranceFormat (const ON_DimStyle *parent_style, ON_DimStyle::tolerance_format format)

void	SetToleranceHeightScale (const ON_DimStyle *parent_style, double scale)

void	SetToleranceLowerValue (const ON_DimStyle *parent_style, double lower_value)

void	SetToleranceResolution (const ON_DimStyle *parent_style, int resolution)

void	SetToleranceUpperValue (const ON_DimStyle *parent_style, double upper_value)

void	SetToleranceZeroSuppress (const ON_DimStyle *parent_style, ON_DimStyle::suppress_zero s)

void	SetZeroSuppress (const ON_DimStyle *parent_style, ON_DimStyle::suppress_zero s)

bool	SignedOrdinate (const ON_DimStyle *parent_style) const

ON_DimStyle::stack_format	StackFractionFormat (const ON_DimStyle *parent_style) const

double	StackHeightScale (const ON_DimStyle *parent_style) const

const wchar_t *	Suffix (const ON_DimStyle *parent_style) const
	Dimension suffix text. More...

bool	SuppressArrow1 (const ON_DimStyle *parent_style) const

bool	SuppressArrow2 (const ON_DimStyle *parent_style) const

bool	SuppressExtension1 (const ON_DimStyle *parent_style) const
	Suppress first dimension extension line. More...

bool	SuppressExtension2 (const ON_DimStyle *parent_style) const
	Suppress second dimension extension line. More...

const ON_TextContent *	Text () const

ON_TextContent *	Text ()

double	TextGap (const ON_DimStyle *parent_style) const
	Distance from dimension lines to text. More...

double	TextHeight (const ON_DimStyle *parent_style) const
	Height of dimension text. More...

ON::TextHorizontalAlignment	TextHorizontalAlignment (const ON_DimStyle *parent_style) const

int	TextMoveLeader (const ON_DimStyle *parent_style) const

ON::TextOrientation	TextOrientation (const ON_DimStyle *parent_style) const

virtual double	TextRotationDegrees () const
	return angle in degrees between text plane and object plane More...

virtual double	TextRotationRadians () const
	return angle in radians between text plane and object plane More...

bool	TextUnderlined (const ON_DimStyle *parent_style) const

ON::TextVerticalAlignment	TextVerticalAlignment (const ON_DimStyle *parent_style) const

ON_DimStyle::tolerance_format	ToleranceFormat (const ON_DimStyle *parent_style) const

double	ToleranceHeightScale (const ON_DimStyle *parent_style) const

double	ToleranceLowerValue (const ON_DimStyle *parent_style) const

int	ToleranceResolution (const ON_DimStyle *parent_style) const

double	ToleranceUpperValue (const ON_DimStyle *parent_style) const

ON_DimStyle::suppress_zero	ToleranceZeroSuppress (const ON_DimStyle *parent_style) const

ON::AnnotationType	Type () const

ON_DimStyle::suppress_zero	ZeroSuppress (const ON_DimStyle *parent_style) const

Public Member Functions inherited from ON_Geometry
	ON_Geometry ()=default

	ON_Geometry (const ON_Geometry &)=default

	~ON_Geometry ()=default

ON_BoundingBox	BoundingBox () const
	Get object's 3d axis aligned bounding box. More...

virtual class ON_Brep *	BrepForm (class ON_Brep *brep=nullptr) const
	If possible, BrepForm() creates a brep form of the ON_Geometry. More...

virtual void	ClearBoundingBox ()
	Some objects cache bounding box information. If you modify an object, then call ClearBoundingBox() to inform the object that any cached bounding boxes are invalid. More...

virtual ON_COMPONENT_INDEX	ComponentIndex () const
	If this piece of geometry is a component in something larger, like an ON_BrepEdge in an ON_Brep, then this function returns the component index. More...

virtual int	Dimension () const
	Dimension of the object. More...

virtual bool	EvaluatePoint (const class ON_ObjRef &objref, ON_3dPoint &P) const
	Evaluate the location of a point from the object reference. More...

virtual bool	GetBBox (double boxmin, double boxmax, bool bGrowBox=false) const
	This is the virtual function that actually calculates axis aligned bounding boxes. More...

bool	GetBoundingBox (ON_BoundingBox &bbox, bool bGrowBox=false) const
	Get object's 3d axis aligned bounding box or the union of the input box with the object's bounding box. More...

bool	GetBoundingBox (ON_3dPoint &bbox_min, ON_3dPoint &bbox_max, bool bGrowBox=false) const
	Get corners of object's 3d axis aligned bounding box or the union of the input box with the object's bounding box. More...

virtual bool	GetTightBoundingBox (class ON_BoundingBox &tight_bbox, bool bGrowBox=false, const class ON_Xform *xform=nullptr) const
	Get tight bounding box. More...

virtual bool	HasBrepForm () const
	Query an object to see if it has an ON_Brep form. Result: Returns true if the virtual ON_Geometry::BrepForm can compute an ON_Brep representation of this object. More...

virtual bool	IsDeformable () const

bool	IsValid (class ON_TextLog *text_log=nullptr) const override
	Tests an object to see if its data members are correctly initialized. More...

virtual bool	MakeDeformable ()
	If possible, converts the object into a form that can be accuratly modified with "squishy" transformations like projections, shears, an non-uniform scaling. More...

ON_Geometry &	operator= (const ON_Geometry &)=default

bool	Rotate (double sin_angle, double cos_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
	Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). More...

bool	Rotate (double rotation_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
	Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). More...

bool	Scale (double scale_factor)
	Scales the object by the specified facotor. The scale is centered at the origin. More...

virtual bool	SwapCoordinates (int i, int j)
	Swaps object coordinate values with indices i and j. More...

virtual bool	Transform (const ON_Xform &xform)
	Transforms the object. More...

bool	Translate (const ON_3dVector &translation_vector)
	Translates the object along the specified vector. More...

Public Member Functions inherited from ON_Object
	ON_Object () ON_NOEXCEPT

	ON_Object (const ON_Object &)

virtual	~ON_Object ()

virtual ON_AggregateComponentStatus	AggregateComponentStatus () const
	Call whenever a component status setting is modifed by directly changing it on a component in a way that will result in any saved information about the parent object's aggretate component status becoming invalid. More...

bool	AttachUserData (class ON_UserData *pUserData)
	Attach user data to an object. More...

unsigned int	ClearAllComponentStates () const
	Set all active level component states to ON_ComponentStatus::NoneSet. More...

virtual unsigned int	ClearComponentStates (ON_ComponentStatus states_to_clear) const
	Clear the specified states on every component. More...

virtual unsigned int	ClearComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_clear) const
	Clear states on an individual component. More...

unsigned int	CopyUserData (const ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution)
	Expert user tool that copies user data items with positive values of ON_UserData.m_userdata_copycount from source_object to "this. More...

void	CopyUserData (const ON_Object &source_object)
	Calls CopyUserData(source_object,ON_Object::UserDataConflictResolution::source_object). More...

virtual ON__UINT32	DataCRC (ON__UINT32 current_remainder) const
	Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical. More...

virtual bool	DeleteComponents (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)
	Delete the portions of the object identified in ci_list[]. More...

virtual void	DestroyRuntimeCache (bool bDelete=true)
	Expert user function. If you are using openNURBS in its default configuration to read and write 3dm archives, you never need to call this function. Many objects employ lazy creation of (runtime) caches that save information to help speed geometric calculations. This function will destroy all runtime information. More...

bool	DetachUserData (class ON_UserData *pUserData)
	Remove user data from an object. More...

virtual void	Dump (ON_TextLog &) const
	Creates a text dump of the object. More...

void	EmergencyDestroy ()
	Sets m_user_data_list = 0. More...

class ON_UserData *	FirstUserData () const
	User data is stored as a linked list of ON_UserData classes. FirstUserData gets the first item in the linked list. This is the most recent item attached using AttachUserData(). Remark: To iterate through all the user data on an object, call FirstUserData() and then use ON_UserData::Next() to traverse the list. More...

virtual unsigned int	GetComponentsWithSetStates (ON_ComponentStatus states_filter, bool bAllEqualStates, ON_SimpleArray< ON_COMPONENT_INDEX > &components) const

class ON_UserData *	GetUserData (const ON_UUID &userdata_uuid) const
	Get a pointer to user data. More...

bool	GetUserString (const wchar_t *key, ON_wString &string_value) const
	Get user string from the object. More...

int	GetUserStringKeys (ON_ClassArray< ON_wString > &user_string_keys) const
	Get a list of all user string keys on the object. More...

int	GetUserStrings (ON_ClassArray< ON_UserString > &user_strings) const
	Get a list of all user strings on the object. More...

bool	IsKindOf (const ON_ClassId *pClassId) const
	Low level tool to test if an object is derived from a specified class. More...

virtual void	MarkAggregateComponentStatusAsNotCurrent () const
	Call whenever a component status setting is modifed by directly changing it on a component in a way that will result in any saved information about the parent object's aggretate component status becoming invalid. More...

virtual void	MemoryRelocate ()
	The MemoryRelocate() function is called when an object's location in memory is changed. For example, if an object resides in a chunk of memory that is grown by calling a realloc that has to allocate a new chunk and copy the contents of the old chunk to the new chunk, then the location of the object's memory changes. In practice this happens when classes derived from ON_Object are stored in dynamic arrays, like the default implementation of ON_ObjectArray<>'s that use realloc to grow the dynamic array. More...

virtual ON_UUID	ModelObjectId () const
	All objects in an opennurbs model have an id ( ON_Layer.m_layer_id, ON_Font.m_font_id, ON_Material.m_material_id, ON_3dmObjectAttributes.m_uuid ). More...

unsigned int	MoveUserData (ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution, bool bDeleteAllSourceItems)
	Expert user tool that moves user data items from source_object to "this. More...

void	MoveUserData (ON_Object &source_object)
	Calls MoveUserData(source_object,ON_Object::UserDataConflictResolution::source_object,true). More...

ON_Object &	operator= (const ON_Object &)

void	PurgeUserData ()
	PurgeUserData() removes all user data from object. More...

virtual bool	Read (ON_BinaryArchive &binary_archive)
	Low level archive writing tool used by ON_BinaryArchive::ReadObject(). More...

virtual unsigned int	SetComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_set) const
	Set states on an individual component. More...

virtual unsigned int	SetComponentStatus (ON_COMPONENT_INDEX component_index, ON_ComponentStatus status_to_copy) const
	Copy status settings to an individual component. More...

bool	SetUserString (const wchar_t key, const wchar_t string_value)
	Attach a user string to the object. This information will perisist through copy construction, operator=, and file IO. More...

int	SetUserStrings (int count, const ON_UserString *user_strings, bool bReplace)
	Append entries to the user string list More...

virtual unsigned int	SizeOf () const

void	TransformUserData (const class ON_Xform &xform)
	Objects derived from ON_Geometry must call TransformUserData() in their Transform() member function. More...

virtual bool	UpdateReferencedComponents (const class ON_ComponentManifest &source_manifest, const class ON_ComponentManifest &destination_manifest, const class ON_ManifestMap &manifest_map)
	Uses the destination_manifest to update references to other components. This is typically done when a component's references came from a "source" context and are being updated to the "destination" context. For example, inserting one model into another when index, id, and name conflicts need to be resolved at the time of insertion. More...

int	UserStringCount () const

virtual bool	Write (ON_BinaryArchive &binary_archive) const
	Low level archive writing tool used by ON_BinaryArchive::WriteObject(). More...

Static Public Member Functions
static bool	ClearRtfFmt (const wchar_t fmt_str_on, const wchar_t fmt_str_off, ON_wString &rtf_in)

static ON_Annotation *	CreateFromV2Annotation (const class ON_OBSOLETE_V2_Annotation &V2_annotation, const class ON_3dmAnnotationContext *annotation_context)

static ON_Annotation *	CreateFromV5Annotation (const class ON_OBSOLETE_V5_Annotation &V5_annotation, const class ON_3dmAnnotationContext *annotation_context)

static int	FindRtfTable (ON_wString rtf_in, int startidx, const wchar_t *tablename)

static bool	FirstCharTextProperties (const wchar_t *rtf_in, bool &bold, bool &italic, bool &underline, ON_wString &facename)

static ON_3dVector	GetDefaultHorizontal (const ON_Plane &plane)

static bool	SetAnnotationTextFormat (ON_wString &rtf_in, const wchar_t fmt_str_on, const wchar_t fmt_str_off, bool set_on)

static bool	SetRtfFmt (ON_wString &rtf_in, const wchar_t *fmt_str)

Protected Member Functions
	ON_Annotation (ON::AnnotationType annotation_type)

	ON_Annotation (const ON_Annotation &src)

	~ON_Annotation ()

bool	Internal_GetBBox_Begin (const ON_SHA1_Hash &hash, double boxmin, double boxmax, bool bGrow) const

bool	Internal_GetBBox_End (const ON_BoundingBox &bbox, const ON_SHA1_Hash &hash, double boxmin, double boxmax, bool bGrow) const

const ON_SHA1_Hash	Internal_GetBBox_InputHash (const ON_Viewport vp, const ON_DimStyle dimstyle, double dimscale, const ON_2dPoint &text_point, unsigned int point_count, const ON_2dPoint *points) const

bool	Internal_GetBBox_TextGlyphBox (const ON_Viewport vp, const ON_DimStyle dimstyle, double dimscale, ON_BoundingBox &text_glyph_box) const

bool	Internal_ReadAnnotation (ON_BinaryArchive &archive)

void	Internal_SetDimStyleFromV5Annotation (const class ON_OBSOLETE_V5_Annotation &V5_annotation, const class ON_3dmAnnotationContext *annotation_context)

bool	Internal_WriteAnnotation (ON_BinaryArchive &archive) const

ON_Annotation &	operator= (const ON_Annotation &src)

Static Protected Member Functions
static bool	Internal_IsOverrideDimStyleCandidate (const ON_DimStyle *override_style_candidate, ON_UUID parent_id, bool bRequireSetOverrides, bool bIssueErrorsAndWarnings)

Protected Attributes
ON::AnnotationType	m_annotation_type = ON::AnnotationType::Unset

ON_UUID	m_dimstyle_id = ON_DimStyle::Default.Id()

ON_2dVector	m_horizontal_direction = ON_2dVector::XAxis

ON_Plane	m_plane = ON_Plane::World_xy

unsigned char	m_reserved1 = 0

unsigned char	m_reserved2 = 0

unsigned char	m_reserved3 = 0

unsigned int	m_reserved4 = 0

ON_TextContent *	m_text = nullptr

Additional Inherited Members
Public Types inherited from ON_Object
enum	UserDataConflictResolution : unsigned char { UserDataConflictResolution::destination_object = 0, UserDataConflictResolution::source_object = 1, UserDataConflictResolution::source_copycount_gt = 2, UserDataConflictResolution::source_copycount_ge = 3, UserDataConflictResolution::destination_copycount_gt = 4, UserDataConflictResolution::destination_copycount_ge = 5, UserDataConflictResolution::delete_item = 6 }
	When a userdata item is copied or moved from a source object to a destination object, the ON_Object::UserDataConflictResolution enum values specify how conficts are resolved. Remark: A userdata item "conflict" occurs when both the destination and source object have a user data item with the same value of ON_UserData::m_userdata_uuid. More...

Static Public Attributes inherited from ON_Geometry
static const ON_Geometry	Unset

Constructor & Destructor Documentation

◆ ON_Annotation() [1/2]

ON_Annotation::ON_Annotation ( ON::AnnotationType annotation_type )

protected

◆ ON_Annotation() [2/2]

ON_Annotation::ON_Annotation ( const ON_Annotation & src )

protected

◆ ~ON_Annotation()

ON_Annotation::~ON_Annotation ( )

protected

Member Function Documentation

◆ Alternate()

bool ON_Annotation::Alternate ( const ON_DimStyle * parent_style ) const

Additional measurement display toggle.

◆ AlternateBelow()

bool ON_Annotation::AlternateBelow ( const ON_DimStyle * parent_style ) const

◆ AlternateDimensionLengthDisplay()

ON_DimStyle::LengthDisplay ON_Annotation::AlternateDimensionLengthDisplay ( const ON_DimStyle * parent_style ) const

◆ AlternateDimensionLengthDisplayUnit()

ON::LengthUnitSystem ON_Annotation::AlternateDimensionLengthDisplayUnit	(	const ON_DimStyle *	parent_style,
		unsigned int	model_sn
	)		const

Parameters: model_sn - 0, a model serial number, or ON_UNSET_UINT_INDEX to use the dimstyle's ModelSerialNumber() value. Returns Unit system for dimension length display. If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits and model_sn > 0, then the value of ON::LengthUnitSystemFromModelSerialNumber(model_sn) is returned. If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits and model_sn == 0, then ON::LengthUnitSystem::None is returned.

◆ AlternateLengthFactor()

double ON_Annotation::AlternateLengthFactor ( const ON_DimStyle * parent_style ) const

Distance scale factor for alternate display.

◆ AlternateLengthResolution()

int ON_Annotation::AlternateLengthResolution ( const ON_DimStyle * parent_style ) const

Display resolution for alternate length measurements.

◆ AlternatePrefix()

const wchar_t* ON_Annotation::AlternatePrefix ( const ON_DimStyle * parent_style ) const

Dimension alternate prefix text.

◆ AlternateRoundOff()

double ON_Annotation::AlternateRoundOff ( const ON_DimStyle * parent_style ) const

◆ AlternateSuffix()

const wchar_t* ON_Annotation::AlternateSuffix ( const ON_DimStyle * parent_style ) const

Dimension alternate suffix text.

◆ AlternateToleranceResolution()

int ON_Annotation::AlternateToleranceResolution ( const ON_DimStyle * parent_style ) const

◆ AlternateZeroSuppress()

ON_DimStyle::suppress_zero ON_Annotation::AlternateZeroSuppress ( const ON_DimStyle * parent_style ) const

◆ AngleFormat()

ON_DimStyle::angle_format ON_Annotation::AngleFormat ( const ON_DimStyle * parent_style ) const

Angle units - Degrees, Degrees-Minutes-Seconds, Radians.

◆ AngleResolution()

int ON_Annotation::AngleResolution ( const ON_DimStyle * parent_style ) const

Display resolution for angle measurements.

◆ AngleRoundOff()

double ON_Annotation::AngleRoundOff ( const ON_DimStyle * parent_style ) const

◆ AngleZeroSuppress()

ON_DimStyle::suppress_zero ON_Annotation::AngleZeroSuppress ( const ON_DimStyle * parent_style ) const

◆ ArcLengthSymbol()

int ON_Annotation::ArcLengthSymbol ( const ON_DimStyle * parent_style ) const

◆ ArrowBlockId1()

ON_UUID ON_Annotation::ArrowBlockId1 ( const ON_DimStyle * parent_style ) const

◆ ArrowBlockId2()

ON_UUID ON_Annotation::ArrowBlockId2 ( const ON_DimStyle * parent_style ) const

◆ ArrowSize()

double ON_Annotation::ArrowSize ( const ON_DimStyle * parent_style ) const

Arrow size.

◆ ArrowType1()

ON_Arrowhead::arrow_type ON_Annotation::ArrowType1 ( const ON_DimStyle * parent_style ) const

◆ ArrowType2()

ON_Arrowhead::arrow_type ON_Annotation::ArrowType2 ( const ON_DimStyle * parent_style ) const

◆ BaselineSpacing()

double ON_Annotation::BaselineSpacing ( const ON_DimStyle * parent_style ) const

◆ CenterMarkSize()

double ON_Annotation::CenterMarkSize ( const ON_DimStyle * parent_style ) const

Centermark size.

◆ CenterMarkStyle()

ON_DimStyle::centermark_style ON_Annotation::CenterMarkStyle ( const ON_DimStyle * parent_style ) const

Centermark style.

◆ ClearFieldOverride()

void ON_Annotation::ClearFieldOverride ( ON_DimStyle::field field )

◆ ClearOverrideDimensionStyle()

void ON_Annotation::ClearOverrideDimensionStyle ( )

Removes any override dimension style that is present.

◆ ClearRtfFmt()

static bool ON_Annotation::ClearRtfFmt	(	const wchar_t *	fmt_str_on,
		const wchar_t *	fmt_str_off,
		ON_wString &	rtf_in
	)

static

◆ ClearText()

void ON_Annotation::ClearText ( ) const

◆ CreateFromV2Annotation()

static ON_Annotation* ON_Annotation::CreateFromV2Annotation	(	const class ON_OBSOLETE_V2_Annotation &	V2_annotation,
		const class ON_3dmAnnotationContext *	annotation_context
	)

static

◆ CreateFromV5Annotation()

static ON_Annotation* ON_Annotation::CreateFromV5Annotation	(	const class ON_OBSOLETE_V5_Annotation &	V5_annotation,
		const class ON_3dmAnnotationContext *	annotation_context
	)

static

◆ DimensionLengthDisplay()

ON_DimStyle::LengthDisplay ON_Annotation::DimensionLengthDisplay ( const ON_DimStyle * parent_style ) const

◆ DimensionLengthDisplayUnit()

ON::LengthUnitSystem ON_Annotation::DimensionLengthDisplayUnit	(	const ON_DimStyle *	parent_style,
		unsigned int	model_sn
	)		const

Parameters: model_sn - 0, a model serial number, or ON_UNSET_UINT_INDEX to use the dimstyle's ModelSerialNumber() value. Returns Unit system for dimension length display. If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits and model_sn > 0, then the value of ON::LengthUnitSystemFromModelSerialNumber(model_sn) is returned. If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits and model_sn == 0, then ON::LengthUnitSystem::None is returned.

◆ DimensionStyle() [1/2]

const ON_DimStyle& ON_Annotation::DimensionStyle ( const ON_DimStyle & parent_dimstyle ) const

◆ DimensionStyle() [2/2]

const ON_DimStyle& ON_Annotation::DimensionStyle	(	const ON_DimStyle &	parent_dimstyle,
		bool	bForceOverrideUpdate
	)		const

◆ DimensionStyleId()

ON_UUID ON_Annotation::DimensionStyleId ( ) const

◆ DimExtension()

double ON_Annotation::DimExtension ( const ON_DimStyle * parent_style ) const

Extension of dimension line past extension lines.

◆ DimRadialTextAngleStyle()

ON_DimStyle::ContentAngleStyle ON_Annotation::DimRadialTextAngleStyle ( const ON_DimStyle * parent_style ) const

◆ DimRadialTextLocation()

ON_DimStyle::TextLocation ON_Annotation::DimRadialTextLocation ( const ON_DimStyle * parent_style ) const

The location of text relative to the dimension line in radial dimensions.

◆ DimRadialTextOrientation()

ON::TextOrientation ON_Annotation::DimRadialTextOrientation ( const ON_DimStyle * parent_style ) const

◆ DimScale()

double ON_Annotation::DimScale ( const ON_DimStyle * parent_style ) const

◆ DimStyleTextPositionPropertiesHash()

ON_SHA1_Hash ON_Annotation::DimStyleTextPositionPropertiesHash ( ) const

Returns: The value of ON_DimStyle.TextPositionPropertiesHash() from the dimension style used to calculate the runtime text position (location, glyphs, and size).

◆ DimTextAngleStyle()

ON_DimStyle::ContentAngleStyle ON_Annotation::DimTextAngleStyle ( const ON_DimStyle * parent_style ) const

◆ DimTextLocation()

ON_DimStyle::TextLocation ON_Annotation::DimTextLocation ( const ON_DimStyle * parent_style ) const

The location of text relative to the dimension line in linear, angular, and ordinate dimensions.

◆ DimTextOrientation()

ON::TextOrientation ON_Annotation::DimTextOrientation ( const ON_DimStyle * parent_style ) const

◆ DrawForward()

bool ON_Annotation::DrawForward ( const ON_DimStyle * parent_style ) const

◆ DrawTextMask()

bool ON_Annotation::DrawTextMask ( const ON_DimStyle * parent_style ) const

Determines whether or not to draw a Text Mask.

◆ EqualTextPositionProperties()

bool ON_Annotation::EqualTextPositionProperties ( const class ON_DimStyle * dimstyle ) const

Returns: True if this text position information used to create this text is identical to the text position paramters on dimstyle.

◆ ExtensionLineExtension()

double ON_Annotation::ExtensionLineExtension ( const ON_DimStyle * parent_style ) const

These next several functions are to set overrides on individual annotation objects.

Extension line extension

◆ ExtensionLineOffset()

double ON_Annotation::ExtensionLineOffset ( const ON_DimStyle * parent_style ) const

Extension line offset.

◆ FieldIsOverridden()

bool ON_Annotation::FieldIsOverridden ( ON_DimStyle::field field ) const

◆ FindRtfTable()

static int ON_Annotation::FindRtfTable	(	ON_wString	rtf_in,
		int	startidx,
		const wchar_t *	tablename
	)

static

◆ FirstCharTextProperties()

static bool ON_Annotation::FirstCharTextProperties	(	const wchar_t *	rtf_in,
		bool &	bold,
		bool &	italic,
		bool &	underline,
		ON_wString &	facename
	)

static

◆ FixedExtensionLength()

double ON_Annotation::FixedExtensionLength ( const ON_DimStyle * parent_style ) const

◆ FixedExtensionLengthOn()

bool ON_Annotation::FixedExtensionLengthOn ( const ON_DimStyle * parent_style ) const

◆ Font()

const class ON_Font& ON_Annotation::Font ( const ON_DimStyle * parent_style ) const

Returns: The managed font used to render text.

◆ FontCharacteristics()

const class ON_Font& ON_Annotation::FontCharacteristics ( const ON_DimStyle * parent_style ) const

Returns: A copy of the font_characteristics information.

You probably want to use Font(). This function is only useful in isolated situations and is typically used to study font substitutions when a model moves between computers or platforms.

◆ FontSubstituted()

const bool ON_Annotation::FontSubstituted ( const ON_DimStyle * parent_style ) const

Returns: True if the font returned by Font() is a substitute for the font passed to SetFont().

Font substitution can occur when a model is moved between computers that have different fonts installed.

◆ FormattingRectangleWidth()

double ON_Annotation::FormattingRectangleWidth ( ) const

FormattingRectangleWidth is a width set by text wrapping. It's in model units.

◆ GetAlignment()

void ON_Annotation::GetAlignment	(	ON::TextHorizontalAlignment &	horz,
		ON::TextVerticalAlignment &	vert
	)		const

◆ GetAnnotationBoundingBox()

virtual bool ON_Annotation::GetAnnotationBoundingBox	(	const ON_Viewport *	vp,
		const ON_DimStyle *	dimstyle,
		double	dimscale,
		double *	boxmin,
		double *	boxmax,
		bool	bGrow = `false`
	)		const

pure virtual

Implemented in ON_Centermark, ON_DimOrdinate, ON_DimRadial, ON_DimAngular, ON_DimLinear, ON_Text, and ON_Leader.

◆ GetDefaultHorizontal()

static ON_3dVector ON_Annotation::GetDefaultHorizontal ( const ON_Plane & plane )

static

◆ GetText3dCorners()

bool ON_Annotation::GetText3dCorners ( ON_3dPoint corners[4] ) const

◆ GetTextGlyphContours()

bool ON_Annotation::GetTextGlyphContours	(	const ON_Viewport *	vp,
		const ON_DimStyle *	dimstyle,
		bool	bApplyDimStyleDimScale,
		bool	bSingleStrokeFont,
		ON_ClassArray< ON_ClassArray< ON_SimpleArray< ON_Curve * > > > &	text_contours
	)		const

Parameters

vp	[in] nullptr or viewport where annotation object is displayed
dimstyle	[in] &this->DimensionStyle(const ON_DimStyle& parent_dimstyle)
bApplyDimStyleDimScale	[in] If true, dimsytyle->DimScale() is applied. If vp is a page view, bApplyDimStyleDimScale is generally false. If vp is a model view, bApplyDimStyleDimScale is generally the value of a model property IsAnnotationScalingEnabled(). from
bSingleStrokeFont	[in] True if text uses a single font that is a single stroke font and returned contours should be left open.
text_contours	[out]

◆ GetTextXform()

virtual bool ON_Annotation::GetTextXform	(	const ON_Viewport *	vp,
		const ON_DimStyle *	dimstyle,
		double	dimscale,
		ON_Xform &	text_xform_out
	)		const

pure virtual

Implemented in ON_Centermark, ON_DimOrdinate, ON_DimRadial, ON_DimAngular, ON_DimLinear, ON_Text, and ON_Leader.

◆ HasDimensionStyleOverrides()

bool ON_Annotation::HasDimensionStyleOverrides ( ) const

Quickly check if this annotation object has style overrides applied.

◆ HorizontalDirection()

const ON_2dVector ON_Annotation::HorizontalDirection ( ) const

◆ Internal_GetBBox_Begin()

bool ON_Annotation::Internal_GetBBox_Begin	(	const ON_SHA1_Hash &	hash,
		double *	boxmin,
		double *	boxmax,
		bool	bGrow
	)		const

protected

Returns: True if a cached bounding box was found and boxmin, boxmax are set.

◆ Internal_GetBBox_End()

bool ON_Annotation::Internal_GetBBox_End	(	const ON_BoundingBox &	bbox,
		const ON_SHA1_Hash &	hash,
		double *	boxmin,
		double *	boxmax,
		bool	bGrow
	)		const

protected

Returns: True if a boxmin, boxmax is a valid bounding box

◆ Internal_GetBBox_InputHash()

const ON_SHA1_Hash ON_Annotation::Internal_GetBBox_InputHash	(	const ON_Viewport *	vp,
		const ON_DimStyle *	dimstyle,
		double	dimscale,
		const ON_2dPoint &	text_point,
		unsigned int	point_count,
		const ON_2dPoint *	points
	)		const

protected

Parameters

vp	[in] nullptr or viewport where annotation object is displayed
dimstyle	[in] &this->DimensionStyle(const ON_DimStyle& parent_dimstyle)

◆ Internal_GetBBox_TextGlyphBox()

bool ON_Annotation::Internal_GetBBox_TextGlyphBox	(	const ON_Viewport *	vp,
		const ON_DimStyle *	dimstyle,
		double	dimscale,
		ON_BoundingBox &	text_glyph_box
	)		const

protected

Parameters

vp	[in] nullptr or viewport where annotation object is displayed
dimstyle	[in] &this->DimensionStyle(const ON_DimStyle& parent_dimstyle)

◆ Internal_IsOverrideDimStyleCandidate()

static bool ON_Annotation::Internal_IsOverrideDimStyleCandidate	(	const ON_DimStyle *	override_style_candidate,
		ON_UUID	parent_id,
		bool	bRequireSetOverrides,
		bool	bIssueErrorsAndWarnings
	)

staticprotected

◆ Internal_ReadAnnotation()

bool ON_Annotation::Internal_ReadAnnotation ( ON_BinaryArchive & archive )

protected

◆ Internal_SetDimStyleFromV5Annotation()

void ON_Annotation::Internal_SetDimStyleFromV5Annotation	(	const class ON_OBSOLETE_V5_Annotation &	V5_annotation,
		const class ON_3dmAnnotationContext *	annotation_context
	)

protected

◆ Internal_WriteAnnotation()

bool ON_Annotation::Internal_WriteAnnotation ( ON_BinaryArchive & archive ) const

protected

◆ IsOverrideDimStyleCandidate()

bool ON_Annotation::IsOverrideDimStyleCandidate	(	const ON_DimStyle *	override_style_candidate,
		bool	bRequireSetOverrides
	)		const

A valid override dimstyle candidate has all of the following properties. override_style_candidate != nullptr. IsDeleted() = false; Id() = ON_nil_uuid; Name() is empty. Index() = ON_ModelComponent::Unset.Index() bRequireSetOverrides is false or HasOverrides() returns true.

Parameters

override_style_candidate	[in] style candidate to evaluate.
bRequireSetOverrides	[in] If bRequireSetOverrides is true, then override_style_candidate->HasOverrides() must be true for a valid candidate. If bRequireSetOverrides is flase, then override_style_candidate->HasOverrides() can have any value.

Returns: True if override_style could be successfully used as the parameter to SetOverrideDimensionStyle.

◆ IsOverrideStylePointer()

bool ON_Annotation::IsOverrideStylePointer ( const ON_DimStyle * ptr ) const

Parameters

ptr	[in] pointer to test

Returns: True if ptr is not nullptr and points to the override style mangaged by this instance.

◆ IsValid()

bool ON_Annotation::IsValid ( class ON_TextLog * text_log = nullptr ) const

overridevirtual

Tests an object to see if its data members are correctly initialized.

Parameters

text_log	[in] if the object is not valid and text_log is not nullptr, then a brief englis description of the reason the object is not valid is appened to the log. The information appended to text_log is suitable for
low	level debugging purposes by programmers and is not intended to be useful as a high level user interface tool.

Returns: table true object is valid false object is invalid, uninitialized, etc.

Reimplemented from ON_Object.

Reimplemented in ON_Dimension, ON_Leader, and ON_Text.

◆ LeaderArrowBlockId()

ON_UUID ON_Annotation::LeaderArrowBlockId ( const ON_DimStyle * parent_style ) const

◆ LeaderArrowSize()

double ON_Annotation::LeaderArrowSize ( const ON_DimStyle * parent_style ) const

Arrow size.

◆ LeaderArrowType()

ON_Arrowhead::arrow_type ON_Annotation::LeaderArrowType ( const ON_DimStyle * parent_style ) const

◆ LeaderContentAngleDegrees()

double ON_Annotation::LeaderContentAngleDegrees ( const ON_DimStyle * parent_style ) const

◆ LeaderContentAngleRadians()

double ON_Annotation::LeaderContentAngleRadians ( const ON_DimStyle * parent_style ) const

◆ LeaderContentAngleStyle()

ON_DimStyle::ContentAngleStyle ON_Annotation::LeaderContentAngleStyle ( const ON_DimStyle * parent_style ) const

◆ LeaderCurveType()

ON_DimStyle::leader_curve_type ON_Annotation::LeaderCurveType ( const ON_DimStyle * parent_style ) const

◆ LeaderHasLanding()

bool ON_Annotation::LeaderHasLanding ( const ON_DimStyle * parent_style ) const

◆ LeaderLandingLength()

double ON_Annotation::LeaderLandingLength ( const ON_DimStyle * parent_style ) const

◆ LeaderTextHorizontalAlignment()

ON::TextHorizontalAlignment ON_Annotation::LeaderTextHorizontalAlignment ( const ON_DimStyle * parent_style ) const

◆ LeaderTextOrientation()

ON::TextOrientation ON_Annotation::LeaderTextOrientation ( const ON_DimStyle * parent_style ) const

◆ LeaderTextVerticalAlignment()

ON::TextVerticalAlignment ON_Annotation::LeaderTextVerticalAlignment ( const ON_DimStyle * parent_style ) const

◆ LengthFactor()

double ON_Annotation::LengthFactor ( const ON_DimStyle * parent_style ) const

Scale factor for displayed distances.

◆ LengthResolution()

int ON_Annotation::LengthResolution ( const ON_DimStyle * parent_style ) const

Display resolution for distance measurements.

◆ MaskBorder()

double ON_Annotation::MaskBorder ( const ON_DimStyle * parent_style ) const

◆ MaskColor()

ON_Color ON_Annotation::MaskColor ( const ON_DimStyle * parent_style ) const

◆ MaskFillType()

ON_TextMask::MaskType ON_Annotation::MaskFillType ( const ON_DimStyle * parent_style ) const

Determines where to get the color to draw a Text Mask.

◆ ObjectType()

ON::object_type ON_Annotation::ObjectType ( ) const

overridevirtual

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.

Returns

ON::object_type enum value.

The default implementation of this virtual function returns ON::unknown_object_type

Reimplemented from ON_Object.

Reimplemented in ON_Leader.

◆ operator=()

ON_Annotation& ON_Annotation::operator= ( const ON_Annotation & src )

protected

◆ PlainText()

const ON_wString ON_Annotation::PlainText ( ) const

Returns: Text information with rich text formatting insturctions removed. Fields are not evaluated.

◆ PlainTextWithFields()

const ON_wString ON_Annotation::PlainTextWithFields ( ) const

Returns: Text information with rich text formatting insturctions removed. The result string from evaluating fields is included Field results may be cached from previous evaluation

◆ Plane()

const ON_Plane& ON_Annotation::Plane ( ) const

◆ Prefix()

const wchar_t* ON_Annotation::Prefix ( const ON_DimStyle * parent_style ) const

Dimension prefix text.

◆ ReplaceTextString()

bool ON_Annotation::ReplaceTextString	(	const wchar_t *	RtfString,
		const ON_DimStyle *	dimstyle
	)

◆ RichText()

const ON_wString ON_Annotation::RichText ( ) const

Returns: Rich text that can contain rich text formatting instructions.

◆ RoundOff()

double ON_Annotation::RoundOff ( const ON_DimStyle * parent_style ) const

◆ RtfText()

const wchar_t* ON_Annotation::RtfText ( ) const

◆ SetAlignment()

void ON_Annotation::SetAlignment	(	ON::TextHorizontalAlignment	horz,
		ON::TextVerticalAlignment	vert
	)

◆ SetAlternate()

void ON_Annotation::SetAlternate	(	const ON_DimStyle *	parent_style,
		bool
	)

◆ SetAlternateBelow()

void ON_Annotation::SetAlternateBelow	(	const ON_DimStyle *	parent_style,
		bool	below
	)

◆ SetAlternateDimensionLengthDisplay()

void ON_Annotation::SetAlternateDimensionLengthDisplay	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::LengthDisplay	length_display
	)

◆ SetAlternateLengthFactor()

void ON_Annotation::SetAlternateLengthFactor	(	const ON_DimStyle *	parent_style,
		double
	)

◆ SetAlternateLengthResolution()

void ON_Annotation::SetAlternateLengthResolution	(	const ON_DimStyle *	parent_style,
		int
	)

◆ SetAlternatePrefix()

void ON_Annotation::SetAlternatePrefix	(	const ON_DimStyle *	parent_style,
		const wchar_t *
	)

◆ SetAlternateRoundOff()

void ON_Annotation::SetAlternateRoundOff	(	const ON_DimStyle *	parent_style,
		double	r
	)

◆ SetAlternateSuffix()

void ON_Annotation::SetAlternateSuffix	(	const ON_DimStyle *	parent_style,
		const wchar_t *
	)

◆ SetAlternateToleranceResolution()

void ON_Annotation::SetAlternateToleranceResolution	(	const ON_DimStyle *	parent_style,
		int	r
	)

◆ SetAlternateZeroSuppress()

void ON_Annotation::SetAlternateZeroSuppress	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::suppress_zero	s
	)

◆ SetAngleFormat()

void ON_Annotation::SetAngleFormat	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::angle_format	format
	)

◆ SetAngleResolution()

void ON_Annotation::SetAngleResolution	(	const ON_DimStyle *	parent_style,
		int	r
	)

◆ SetAngleRoundOff()

void ON_Annotation::SetAngleRoundOff	(	const ON_DimStyle *	parent_style,
		double	r
	)

◆ SetAngleZeroSuppress()

void ON_Annotation::SetAngleZeroSuppress	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::suppress_zero	s
	)

◆ SetAnnotationBold()

bool ON_Annotation::SetAnnotationBold	(	bool	bold,
		const ON_DimStyle *	dimstyle
	)

◆ SetAnnotationFacename()

bool ON_Annotation::SetAnnotationFacename	(	bool	set_or_clear,
		const wchar_t *	facename,
		const ON_DimStyle *	parent_style
	)

◆ SetAnnotationItalic()

bool ON_Annotation::SetAnnotationItalic	(	bool	italic,
		const ON_DimStyle *	dimstyle
	)

◆ SetAnnotationTextFormat()

static bool ON_Annotation::SetAnnotationTextFormat	(	ON_wString &	rtf_in,
		const wchar_t *	fmt_str_on,
		const wchar_t *	fmt_str_off,
		bool	set_on
	)

static

◆ SetAnnotationUnderline()

bool ON_Annotation::SetAnnotationUnderline	(	bool	underline,
		const ON_DimStyle *	dimstyle
	)

◆ SetArcLengthSymbol()

void ON_Annotation::SetArcLengthSymbol	(	const ON_DimStyle *	parent_style,
		int	m
	)

◆ SetArrowBlockId1()

void ON_Annotation::SetArrowBlockId1	(	const ON_DimStyle *	parent_style,
		ON_UUID	id
	)

◆ SetArrowBlockId2()

void ON_Annotation::SetArrowBlockId2	(	const ON_DimStyle *	parent_style,
		ON_UUID	id
	)

◆ SetArrowSize()

void ON_Annotation::SetArrowSize	(	const ON_DimStyle *	parent_style,
		double	d
	)

◆ SetArrowType1()

void ON_Annotation::SetArrowType1	(	const ON_DimStyle *	parent_style,
		ON_Arrowhead::arrow_type
	)

◆ SetArrowType1And2()

void ON_Annotation::SetArrowType1And2	(	const ON_DimStyle *	parent_style,
		ON_Arrowhead::arrow_type
	)

◆ SetArrowType2()

void ON_Annotation::SetArrowType2	(	const ON_DimStyle *	parent_style,
		ON_Arrowhead::arrow_type
	)

◆ SetBaselineSpacing()

void ON_Annotation::SetBaselineSpacing	(	const ON_DimStyle *	parent_style,
		double	spacing
	)

◆ SetCenterMarkSize()

void ON_Annotation::SetCenterMarkSize	(	const ON_DimStyle *	parent_style,
		double	d
	)

◆ SetCenterMarkStyle()

void ON_Annotation::SetCenterMarkStyle	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::centermark_style	style
	)

◆ SetDimensionLengthDisplay()

void ON_Annotation::SetDimensionLengthDisplay	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::LengthDisplay	length_display
	)

◆ SetDimensionStyleId() [1/2]

void ON_Annotation::SetDimensionStyleId ( ON_UUID dimstyle_id )

◆ SetDimensionStyleId() [2/2]

void ON_Annotation::SetDimensionStyleId ( const class ON_DimStyle & dim_style )

Parameters

dim_style [in] If dim_style.ParentId() is nil, then this function calls SetDimensionStyleId(dim_style.Id()) and returns. If dim_style.ParentId() is not nil, then this functions calls SetDimensionStyleId(dim_style.ParentId()) and uses a copy of dim_style as the override dimstyle.

◆ SetDimensionStyleIdForExperts()

void ON_Annotation::SetDimensionStyleIdForExperts	(	ON_UUID	dimstyle_id,
		bool	bKeepOverrides
	)

Set the id of the main (parent) dimstyle used by this annotation object and allow an expert user to control what happens to style override settings in cases where id collisions occur and ids need to be changed.

Parameters

bKeepOverrides [in] If you are not an expert oding something low level and complicated, then call SetDimensionStyleId(dimstyle_id) or pass bKeepOverrides = false.

If bKeepOverrides is true and dimstyle_id is not nil and this object has valid overrides, those overrides are retained. In all other cases, any existing overrides are deleted.

◆ SetDimExtension()

void ON_Annotation::SetDimExtension	(	const ON_DimStyle *	parent_style,
		const double	e
	)

◆ SetDimRadialTextAngleStyle()

void ON_Annotation::SetDimRadialTextAngleStyle	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::ContentAngleStyle	style
	)

◆ SetDimRadialTextLocation()

void ON_Annotation::SetDimRadialTextLocation	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::TextLocation	dim_text_location
	)

◆ SetDimRadialTextOrientation()

void ON_Annotation::SetDimRadialTextOrientation	(	const ON_DimStyle *	parent_style,
		ON::TextOrientation	orientation
	)

◆ SetDimScale()

void ON_Annotation::SetDimScale	(	const ON_DimStyle *	parent_style,
		double	scale
	)

◆ SetDimTextAngleStyle()

void ON_Annotation::SetDimTextAngleStyle	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::ContentAngleStyle	style
	)

◆ SetDimTextLocation()

void ON_Annotation::SetDimTextLocation	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::TextLocation	dim_text_location
	)

◆ SetDimTextOrientation()

void ON_Annotation::SetDimTextOrientation	(	const ON_DimStyle *	parent_style,
		ON::TextOrientation	orientation
	)

◆ SetDrawForward()

void ON_Annotation::SetDrawForward	(	const ON_DimStyle *	parent_style,
		bool	drawforward
	)

◆ SetDrawTextMask()

void ON_Annotation::SetDrawTextMask	(	const ON_DimStyle *	parent_style,
		bool	bDraw
	)

◆ SetExtensionLineExtension()

void ON_Annotation::SetExtensionLineExtension	(	const ON_DimStyle *	parent_style,
		double	d
	)

◆ SetExtensionLineOffset()

void ON_Annotation::SetExtensionLineOffset	(	const ON_DimStyle *	parent_style,
		double	d
	)

◆ SetFixedExtensionLength()

void ON_Annotation::SetFixedExtensionLength	(	const ON_DimStyle *	parent_style,
		double	l
	)

◆ SetFixedExtensionLengthOn()

void ON_Annotation::SetFixedExtensionLengthOn	(	const ON_DimStyle *	parent_style,
		bool	on
	)

◆ SetFont()

void ON_Annotation::SetFont	(	const ON_DimStyle *	parent_style,
		const class ON_Font &	font_characteristics
	)

Set the font used to render text.

Parameters

font_characteristics [in] This parameter does not have to be a managed font.

If the parameter is a managed font (font_characteristics.IsManagedFont() is true), then the identical value is returned by ON_DimStyle.Font(). If the parameter is not a managed font (font_characteristics.IsManagedFont() is false), then the ON_Font::GetManagedFont(font_characteristics) will be returned by ON_DimStyle.Font().

◆ SetFormattingRectangleWidth()

void ON_Annotation::SetFormattingRectangleWidth ( double width )

◆ SetHorizontalDirection()

void ON_Annotation::SetHorizontalDirection ( ON_2dVector )

◆ SetLeaderArrowBlockId()

void ON_Annotation::SetLeaderArrowBlockId	(	const ON_DimStyle *	parent_style,
		ON_UUID	id
	)

◆ SetLeaderArrowSize()

void ON_Annotation::SetLeaderArrowSize	(	const ON_DimStyle *	parent_style,
		double	d
	)

◆ SetLeaderArrowType()

void ON_Annotation::SetLeaderArrowType	(	const ON_DimStyle *	parent_style,
		ON_Arrowhead::arrow_type
	)

◆ SetLeaderContentAngleDegrees()

void ON_Annotation::SetLeaderContentAngleDegrees	(	const ON_DimStyle *	parent_style,
		double	angle_degrees
	)

◆ SetLeaderContentAngleRadians()

void ON_Annotation::SetLeaderContentAngleRadians	(	const ON_DimStyle *	parent_style,
		double	angle_radians
	)

◆ SetLeaderContentAngleStyle()

void ON_Annotation::SetLeaderContentAngleStyle	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::ContentAngleStyle	style
	)

◆ SetLeaderCurveType()

void ON_Annotation::SetLeaderCurveType	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::leader_curve_type	type
	)

◆ SetLeaderHasLanding()

void ON_Annotation::SetLeaderHasLanding	(	const ON_DimStyle *	parent_style,
		bool	landing
	)

◆ SetLeaderLandingLength()

void ON_Annotation::SetLeaderLandingLength	(	const ON_DimStyle *	parent_style,
		double	length
	)

◆ SetLeaderTextHorizontalAlignment()

void ON_Annotation::SetLeaderTextHorizontalAlignment	(	const ON_DimStyle *	parent_style,
		ON::TextHorizontalAlignment	halign
	)

◆ SetLeaderTextOrientation()

void ON_Annotation::SetLeaderTextOrientation	(	const ON_DimStyle *	parent_style,
		ON::TextOrientation	orientation
	)

◆ SetLeaderTextVerticalAlignment()

void ON_Annotation::SetLeaderTextVerticalAlignment	(	const ON_DimStyle *	parent_style,
		ON::TextVerticalAlignment	style
	)

◆ SetLengthFactor()

void ON_Annotation::SetLengthFactor	(	const ON_DimStyle *	parent_style,
		double
	)

◆ SetLengthResolution()

void ON_Annotation::SetLengthResolution	(	const ON_DimStyle *	parent_style,
		int	r
	)

◆ SetMaskBorder()

void ON_Annotation::SetMaskBorder	(	const ON_DimStyle *	parent_style,
		double	offset
	)

◆ SetMaskColor()

void ON_Annotation::SetMaskColor	(	const ON_DimStyle *	parent_style,
		ON_Color	color
	)

◆ SetMaskFillType()

void ON_Annotation::SetMaskFillType	(	const ON_DimStyle *	parent_style,
		ON_TextMask::MaskType	source
	)

◆ SetOverrideDimensionStyle() [1/2]

bool ON_Annotation::SetOverrideDimensionStyle ( ON_DimStyle *& override_style ) const

Returns: true if the override style was successfully set false if this->m_dimstyle_id is ON_nil_uuid causing failure

◆ SetOverrideDimensionStyle() [2/2]

bool ON_Annotation::SetOverrideDimensionStyle	(	const ON_DimStyle *	override_style_candidate,
		bool	bRequireSetOverrides
	)

If this->IsOverrideDimStyleCandidate(override_style_candidate,bRequireSetOverrides) is true, then a managed copy of override_style_candidate is set as an override.

Returns: True if an override is set.

◆ SetPlane()

void ON_Annotation::SetPlane ( const ON_Plane & plane )

◆ SetPrefix()

void ON_Annotation::SetPrefix	(	const ON_DimStyle *	parent_style,
		const wchar_t *
	)

◆ SetRoundOff()

void ON_Annotation::SetRoundOff	(	const ON_DimStyle *	parent_style,
		double	r
	)

◆ SetRtfFmt()

static bool ON_Annotation::SetRtfFmt	(	ON_wString &	rtf_in,
		const wchar_t *	fmt_str
	)

static

◆ SetSignedOrdinate()

void ON_Annotation::SetSignedOrdinate	(	const ON_DimStyle *	parent_style,
		bool	allowsigned
	)

◆ SetStackFractionFormat()

void ON_Annotation::SetStackFractionFormat	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::stack_format	f
	)

◆ SetStackHeightScale()

void ON_Annotation::SetStackHeightScale	(	const ON_DimStyle *	parent_style,
		double	f
	)

◆ SetSuffix()

void ON_Annotation::SetSuffix	(	const ON_DimStyle *	parent_style,
		const wchar_t *
	)

◆ SetSuppressArrow1()

void ON_Annotation::SetSuppressArrow1	(	const ON_DimStyle *	parent_style,
		bool	s
	)

◆ SetSuppressArrow2()

void ON_Annotation::SetSuppressArrow2	(	const ON_DimStyle *	parent_style,
		bool	s
	)

◆ SetSuppressExtension1()

void ON_Annotation::SetSuppressExtension1	(	const ON_DimStyle *	parent_style,
		bool	b
	)

◆ SetSuppressExtension2()

void ON_Annotation::SetSuppressExtension2	(	const ON_DimStyle *	parent_style,
		bool	b
	)

◆ SetText()

void ON_Annotation::SetText ( ON_TextContent *& text ) const

◆ SetTextGap()

void ON_Annotation::SetTextGap	(	const ON_DimStyle *	parent_style,
		double	gap
	)

◆ SetTextHeight()

void ON_Annotation::SetTextHeight	(	const ON_DimStyle *	parent_style,
		double	height
	)

◆ SetTextHorizontalAlignment()

void ON_Annotation::SetTextHorizontalAlignment	(	const ON_DimStyle *	parent_style,
		ON::TextHorizontalAlignment	halign
	)

◆ SetTextMask()

void ON_Annotation::SetTextMask	(	const ON_DimStyle *	parent_style,
		const ON_TextMask &	mask
	)

◆ SetTextMoveLeader()

void ON_Annotation::SetTextMoveLeader	(	const ON_DimStyle *	parent_style,
		int	m
	)

◆ SetTextOrientation()

void ON_Annotation::SetTextOrientation	(	const ON_DimStyle *	parent_style,
		ON::TextOrientation	orientation
	)

◆ SetTextRotationDegrees()

virtual void ON_Annotation::SetTextRotationDegrees ( double rotation )

virtual

◆ SetTextRotationRadians()

virtual void ON_Annotation::SetTextRotationRadians ( double rotation )

virtual

◆ SetTextUnderlined()

void ON_Annotation::SetTextUnderlined	(	const ON_DimStyle *	parent_style,
		bool	underlined
	)

◆ SetTextVerticalAlignment()

void ON_Annotation::SetTextVerticalAlignment	(	const ON_DimStyle *	parent_style,
		ON::TextVerticalAlignment	style
	)

◆ SetToleranceFormat()

void ON_Annotation::SetToleranceFormat	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::tolerance_format	format
	)

◆ SetToleranceHeightScale()

void ON_Annotation::SetToleranceHeightScale	(	const ON_DimStyle *	parent_style,
		double	scale
	)

◆ SetToleranceLowerValue()

void ON_Annotation::SetToleranceLowerValue	(	const ON_DimStyle *	parent_style,
		double	lower_value
	)

◆ SetToleranceResolution()

void ON_Annotation::SetToleranceResolution	(	const ON_DimStyle *	parent_style,
		int	resolution
	)

◆ SetToleranceUpperValue()

void ON_Annotation::SetToleranceUpperValue	(	const ON_DimStyle *	parent_style,
		double	upper_value
	)

◆ SetToleranceZeroSuppress()

void ON_Annotation::SetToleranceZeroSuppress	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::suppress_zero	s
	)

◆ SetZeroSuppress()

void ON_Annotation::SetZeroSuppress	(	const ON_DimStyle *	parent_style,
		ON_DimStyle::suppress_zero	s
	)

◆ SignedOrdinate()

bool ON_Annotation::SignedOrdinate ( const ON_DimStyle * parent_style ) const

◆ StackFractionFormat()

ON_DimStyle::stack_format ON_Annotation::StackFractionFormat ( const ON_DimStyle * parent_style ) const

◆ StackHeightScale()

double ON_Annotation::StackHeightScale ( const ON_DimStyle * parent_style ) const

◆ Suffix()

const wchar_t* ON_Annotation::Suffix ( const ON_DimStyle * parent_style ) const

Dimension suffix text.

◆ SuppressArrow1()

bool ON_Annotation::SuppressArrow1 ( const ON_DimStyle * parent_style ) const

◆ SuppressArrow2()

bool ON_Annotation::SuppressArrow2 ( const ON_DimStyle * parent_style ) const

◆ SuppressExtension1()

bool ON_Annotation::SuppressExtension1 ( const ON_DimStyle * parent_style ) const

Suppress first dimension extension line.

◆ SuppressExtension2()

bool ON_Annotation::SuppressExtension2 ( const ON_DimStyle * parent_style ) const

Suppress second dimension extension line.

◆ Text() [1/2]

const ON_TextContent* ON_Annotation::Text ( ) const

◆ Text() [2/2]

ON_TextContent* ON_Annotation::Text ( )

◆ TextGap()

double ON_Annotation::TextGap ( const ON_DimStyle * parent_style ) const

Distance from dimension lines to text.

◆ TextHeight()

double ON_Annotation::TextHeight ( const ON_DimStyle * parent_style ) const

Height of dimension text.

◆ TextHorizontalAlignment()

ON::TextHorizontalAlignment ON_Annotation::TextHorizontalAlignment ( const ON_DimStyle * parent_style ) const

◆ TextMoveLeader()

int ON_Annotation::TextMoveLeader ( const ON_DimStyle * parent_style ) const

◆ TextOrientation()

ON::TextOrientation ON_Annotation::TextOrientation ( const ON_DimStyle * parent_style ) const

◆ TextRotationDegrees()

virtual double ON_Annotation::TextRotationDegrees ( ) const

virtual

return angle in degrees between text plane and object plane

◆ TextRotationRadians()

virtual double ON_Annotation::TextRotationRadians ( ) const

virtual

return angle in radians between text plane and object plane

◆ TextUnderlined()

bool ON_Annotation::TextUnderlined ( const ON_DimStyle * parent_style ) const

◆ TextVerticalAlignment()

ON::TextVerticalAlignment ON_Annotation::TextVerticalAlignment ( const ON_DimStyle * parent_style ) const

◆ ToleranceFormat()

ON_DimStyle::tolerance_format ON_Annotation::ToleranceFormat ( const ON_DimStyle * parent_style ) const

◆ ToleranceHeightScale()

double ON_Annotation::ToleranceHeightScale ( const ON_DimStyle * parent_style ) const

◆ ToleranceLowerValue()

double ON_Annotation::ToleranceLowerValue ( const ON_DimStyle * parent_style ) const

◆ ToleranceResolution()

int ON_Annotation::ToleranceResolution ( const ON_DimStyle * parent_style ) const

◆ ToleranceUpperValue()

double ON_Annotation::ToleranceUpperValue ( const ON_DimStyle * parent_style ) const

◆ ToleranceZeroSuppress()

ON_DimStyle::suppress_zero ON_Annotation::ToleranceZeroSuppress ( const ON_DimStyle * parent_style ) const

◆ Type()

ON::AnnotationType ON_Annotation::Type ( ) const

Returns: An ON::AnnotationType value that indicates the type of the annotation.

◆ ZeroSuppress()

ON_DimStyle::suppress_zero ON_Annotation::ZeroSuppress ( const ON_DimStyle * parent_style ) const

Member Data Documentation

◆ m_annotation_type

ON::AnnotationType ON_Annotation::m_annotation_type = ON::AnnotationType::Unset

protected

◆ m_dimstyle_id

ON_UUID ON_Annotation::m_dimstyle_id = ON_DimStyle::Default.Id()

protected

◆ m_horizontal_direction

ON_2dVector ON_Annotation::m_horizontal_direction = ON_2dVector::XAxis

protected

◆ m_plane

ON_Plane ON_Annotation::m_plane = ON_Plane::World_xy

protected

◆ m_reserved1

unsigned char ON_Annotation::m_reserved1 = 0

protected

◆ m_reserved2

unsigned char ON_Annotation::m_reserved2 = 0

protected

◆ m_reserved3

unsigned char ON_Annotation::m_reserved3 = 0

protected

◆ m_reserved4

unsigned int ON_Annotation::m_reserved4 = 0

protected

◆ m_text

ON_TextContent* ON_Annotation::m_text = nullptr

mutableprotected

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ON_Annotation() [1/2]

◆ ON_Annotation() [2/2]

◆ ~ON_Annotation()

Member Function Documentation

◆ Alternate()

◆ AlternateBelow()

◆ AlternateDimensionLengthDisplay()

◆ AlternateDimensionLengthDisplayUnit()

◆ AlternateLengthFactor()

◆ AlternateLengthResolution()

◆ AlternatePrefix()

◆ AlternateRoundOff()

◆ AlternateSuffix()

◆ AlternateToleranceResolution()

◆ AlternateZeroSuppress()

◆ AngleFormat()

◆ AngleResolution()

◆ AngleRoundOff()

◆ AngleZeroSuppress()

◆ ArcLengthSymbol()

◆ ArrowBlockId1()

◆ ArrowBlockId2()

◆ ArrowSize()

◆ ArrowType1()

◆ ArrowType2()

◆ BaselineSpacing()

◆ CenterMarkSize()

◆ CenterMarkStyle()

◆ ClearFieldOverride()

◆ ClearOverrideDimensionStyle()

◆ ClearRtfFmt()

◆ ClearText()

◆ CreateFromV2Annotation()

◆ CreateFromV5Annotation()

◆ DimensionLengthDisplay()

◆ DimensionLengthDisplayUnit()

◆ DimensionStyle() [1/2]

◆ DimensionStyle() [2/2]

◆ DimensionStyleId()

◆ DimExtension()

◆ DimRadialTextAngleStyle()

◆ DimRadialTextLocation()

◆ DimRadialTextOrientation()

◆ DimScale()

◆ DimStyleTextPositionPropertiesHash()

◆ DimTextAngleStyle()

◆ DimTextLocation()

◆ DimTextOrientation()

◆ DrawForward()

◆ DrawTextMask()

◆ EqualTextPositionProperties()

◆ ExtensionLineExtension()

◆ ExtensionLineOffset()

◆ FieldIsOverridden()

◆ FindRtfTable()

◆ FirstCharTextProperties()

◆ FixedExtensionLength()

◆ FixedExtensionLengthOn()

◆ Font()

◆ FontCharacteristics()

◆ FontSubstituted()

◆ FormattingRectangleWidth()

◆ GetAlignment()

◆ GetAnnotationBoundingBox()

◆ GetDefaultHorizontal()

◆ GetText3dCorners()

◆ GetTextGlyphContours()

◆ GetTextXform()

◆ HasDimensionStyleOverrides()

◆ HorizontalDirection()

◆ Internal_GetBBox_Begin()

◆ Internal_GetBBox_End()

◆ Internal_GetBBox_InputHash()