ON_Text Class Reference

#include <opennurbs_textobject.h>

Inheritance diagram for ON_Text:

Public Member Functions
	ON_Text ()
	ON_Text (const ON_Text &src)
	~ON_Text ()
bool	Create (const wchar_t *RtfString, const ON_DimStyle *dimstyle, ON_Plane plane, bool bWrapped, double rect_width, double text_rotation_radians)
	Parses text string and makes runs. More...
bool	Create (const wchar_t *RtfString, const ON_DimStyle *dimstyle, ON_Plane plane)
	Parses text string and makes runs - wrapped = false, rotation = 0. More...
void	Destroy ()
int	Dimension () const override
	Dimension of the object. More...
void	Dump (ON_TextLog &) const override
	virtual More...
bool	GetAnnotationBoundingBox (const ON_Viewport *vp, const ON_DimStyle *dimstyle, double dimscale, double *boxmin, double *boxmax, bool bGrow=false) const override
bool	GetBBox (double *boxmin, double *boxmax, bool bGrowBox=false) const override
	virtual ON_Geometry GetBBox override More...
bool	GetGripPoints (ON_2dPoint &base, ON_2dPoint &width, double textscale) const
	returns the base point and with grip using the current alignments More...
bool	GetTextXform (const ON_Viewport *vp, const ON_DimStyle *dimstyle, double dimscale, ON_Xform &text_xform_out) const override
bool	IsValid (class ON_TextLog *text_log=nullptr) const override
	Tests an object to see if its data members are correctly initialized. More...
ON_Text &	operator= (const ON_Text &src)
bool	Read (ON_BinaryArchive &) override
	Low level archive writing tool used by ON_BinaryArchive::ReadObject(). More...
bool	Transform (const ON_Xform &xform) override
	Transforms the object. More...
bool	Transform (const ON_Xform &xform, const ON_DimStyle *dimstyle)
	Transform the object by a 4x4 xform matrix and change text height override to accomodate scaling in the transform if necessary More...
bool	Write (ON_BinaryArchive &) const override
	Low level archive writing tool used by ON_BinaryArchive::WriteObject(). More...
Public Member Functions inherited from ON_Annotation
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
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
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
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 bool	EvaluatePoint (const class ON_ObjRef &objref, ON_3dPoint &P) const
	Evaluate the location of a point from the object reference. 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
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...
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...
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 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

Static Public Member Functions
static ON_Text *	CreateFromV5TextObject (const class ON_OBSOLETE_V5_TextObject &V5_text_object, const class ON_3dmAnnotationContext *annotation_context, ON_Text *destination)
	Create a V5 text object from a V6 text object. The function is used when reading V5 files. More...
Static Public Member Functions inherited from ON_Annotation
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)

Static Public Attributes
static const ON_Text	Empty
Static Public Attributes inherited from ON_Geometry
static const ON_Geometry	Unset

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...
Protected Member Functions inherited from ON_Annotation
	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 inherited from ON_Annotation
static bool	Internal_IsOverrideDimStyleCandidate (const ON_DimStyle *override_style_candidate, ON_UUID parent_id, bool bRequireSetOverrides, bool bIssueErrorsAndWarnings)
Protected Attributes inherited from ON_Annotation
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

Constructor & Destructor Documentation

ON_Text() [1/2]

ON_Text::ON_Text

(

)

~ON_Text()

ON_Text::~ON_Text

(

)

ON_Text() [2/2]

ON_Text::ON_Text

(

const ON_Text &

src

)

Member Function Documentation

Create() [1/2]

bool ON_Text::Create	(	const wchar_t *	RtfString,
		const ON_DimStyle *	dimstyle,
		ON_Plane	plane,
		bool	bWrapped,
		double	rect_width,
		double	text_rotation_radians
	)

Parses text string and makes runs.

Create() [2/2]

bool ON_Text::Create	(	const wchar_t *	RtfString,
		const ON_DimStyle *	dimstyle,
		ON_Plane	plane
	)

Parses text string and makes runs - wrapped = false, rotation = 0.

CreateFromV5TextObject()

static ON_Text* ON_Text::CreateFromV5TextObject ( const class ON_OBSOLETE_V5_TextObject &  V5_text_object, const class ON_3dmAnnotationContext *  annotation_context, ON_Text *  destination  )

static

Create a V5 text object from a V6 text object. The function is used when reading V5 files.

Parameters

v5_text_object	[in]
dimstyle	[in] Dimstyle referenced by v5_text_object or nullptr if not available.
destination	[in] If destination is not nullptr, then the V6 text object is constructed in destination. If destination is nullptr, then the new V6 text object is allocated with a call to new ON_Text().

Destroy()

void ON_Text::Destroy

(

)

Dimension()

int ON_Text::Dimension ( ) const

overridevirtual

Dimension of the object.

Returns

Dimension of the object.

The dimension is typically three. For parameter space trimming curves the dimension is two. In rare cases the dimension can be one or greater than three.

Reimplemented from ON_Geometry.

Dump()

void ON_Text::Dump ( ON_TextLog &  ) const

overridevirtual

virtual

Reimplemented from ON_Object.

GetAnnotationBoundingBox()

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

overridevirtual

Implements ON_Annotation.

GetBBox()

bool ON_Text::GetBBox ( double *  boxmin, double *  boxmax, bool  bGrowBox = false  ) const

overridevirtual

virtual ON_Geometry GetBBox override

Reimplemented from ON_Geometry.

GetGripPoints()

bool ON_Text::GetGripPoints	(	ON_2dPoint &	base,
		ON_2dPoint &	width,
		double	textscale
	)		const

returns the base point and with grip using the current alignments

GetTextXform()

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

overridevirtual

Implements ON_Annotation.

IsValid()

bool ON_Text::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_Annotation.

operator=()

ON_Text& ON_Text::operator=

(

const ON_Text &

src

)

Read()

bool ON_Text::Read ( ON_BinaryArchive &  binary_archive )

overridevirtual

Low level archive writing tool used by ON_BinaryArchive::ReadObject().

Parameters

binary_archive

archive to read from

Returns

Returns true if the read is successful.

Use ON_BinaryArchive::ReadObject() to read objects. This Read() function should read the objects definition back into its data members.

The default implementation of this virtual function returns false and does nothing.

Reimplemented from ON_Object.

Transform() [1/2]

bool ON_Text::Transform ( const ON_Xform &  xform )

overridevirtual

Transforms the object.

Parameters

xform

[in] transformation to apply to object. If xform.IsSimilarity() is zero, then you may want to call MakeSquishy() before calling Transform.

Classes derived from ON_Geometry should call ON_Geometry::Transform() to handle user data transformations and then transform their definition.

See also

ON_Geometry::IsDeformable();,

Reimplemented from ON_Geometry.

Transform() [2/2]

bool ON_Text::Transform	(	const ON_Xform &	xform,
		const ON_DimStyle *	dimstyle
	)

Transform the object by a 4x4 xform matrix and change text height override to accomodate scaling in the transform if necessary

TODODOC: [in] xform - An ON_Xform with the transformation information

Returns

true = Success false = Failure

The object has been transformed when the function returns If the scale changed because of the transform, an override for text height is either changed, if one already was in place, or is added.

Write()

bool ON_Text::Write ( ON_BinaryArchive &  binary_archive ) const

overridevirtual

Low level archive writing tool used by ON_BinaryArchive::WriteObject().

Parameters

binary_archive

archive to write to

Returns

Returns true if the write is successful.

Use ON_BinaryArchive::WriteObject() to write objects. This Write() function should just write the specific definition of this object. It should not write and any chunk typecode or length information.

The default implementation of this virtual function returns false and does nothing.

Reimplemented from ON_Object.

Member Data Documentation

Empty

const ON_Text ON_Text::Empty

static