#include <opennurbs_text.h>

Inheritance diagram for ON_TextContent:

Public Member Functions
	ON_TextContent ()=default

	ON_TextContent (const ON_TextContent &src)

	~ON_TextContent ()

void	ClearBoundingBox () override
	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...

bool	ComposeText ()

bool	Create (const wchar_t RtfString, ON::AnnotationType annotation_type, const ON_DimStyle dimstyle, bool bWrapped, double rect_width, double text_rotation_radians)
	Parses text string and makes runs. More...

bool	Create (const wchar_t RtfString, ON::AnnotationType annotation_type, const ON_DimStyle dimstyle)

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

ON_SHA1_Hash	DimStyleTextPositionPropertiesHash () const

void	Dump (ON_TextLog &) const override
	virtual More...

bool	EqualTextPositionProperties (ON::AnnotationType annotation_type, const class ON_DimStyle *dimstyle) const

unsigned int	EvaluationSerialNumber () const

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

bool	Get2dCorners (ON_2dPoint corners[4]) const

ON_Mesh *	Get2dPickMesh () const

bool	Get2dSize (bool raw, double &width, double &height) const
	Get the size of a 2d rectangle enclosing text. More...

bool	Get3dCorners (ON_3dPoint corners[4]) const

bool	Get3dMaskCorners (double border, ON_3dPoint corners[4]) const

ON_Mesh *	Get3dPickMesh () const

bool	Get3dUnderline (ON_3dPoint ends[2], double scaled_gap) const
	Gets endpoints of a line under the text offset down by textgap. More...

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

bool	GetBBox (double boxmin, double boxmax, bool bGrowBox=false) const override
	virtual ON_Geometry GetBBox override More...

bool	GetGlyphContours (const ON_Font text_font, bool bSingleStrokeFont, double text_height, ON_ClassArray< ON_ClassArray< ON_SimpleArray< ON_Curve > > > &text_contours) const

bool	GetGlyphContours (const ON_Font text_font, bool bSingleStrokeFont, const ON_Xform &text_xform, ON_ClassArray< ON_ClassArray< ON_SimpleArray< ON_Curve > > > &text_contours) const

void	GetGripPoints (ON_2dPoint &base, ON_2dPoint &width) const
	returns the base point and with grip using the current alignments More...

bool	GetRun3dCorners (const ON_TextRun *run, ON_3dPoint corners[4]) const

bool	HasWrappedRuns () const
	True if text has wrapped runs, else false. More...

bool	IsValid (class ON_TextLog *text_log=nullptr) const override
	Tests an object to see if its data members are correctly initialized. 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...

ON_TextContent &	operator= (const ON_TextContent &src)

const ON_wString	PlainText () const

const ON_wString	PlainTextWithFields () const

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

void	RealignTextRuns (ON::TextHorizontalAlignment new_h_align)

bool	RebuildRuns (ON::AnnotationType annotation_type, const ON_DimStyle *dimstyle)

bool	ReplaceTextString (const wchar_t RtfString, ON::AnnotationType annotation_type, const ON_DimStyle dimstyle)

const ON_wString	RichText () const

const wchar_t *	RtfText () const

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

void	SetEvaluationSerialNumber (unsigned int sn) const

void	SetFormattingRectangleWidth (double width)

void	SetTextIsWrapped (bool wrapped)

void	SetTextRotationDegrees (double rotation)

void	SetTextRotationRadians (double rotation)

const ON_BoundingBox	TextContentBoundingBox () const

ON_SHA1_Hash	TextContentHash () const

ON_SHA1_Hash	TextContentHash (bool bApplyWrapping, bool bEvaluateFields) const

bool	TextIsWrapped () const
	True if flag to wrap is set. More...

double	TextRotationDegrees () const
	Rotation in degrees around origin. More...

double	TextRotationRadians () const
	Rotation in radians around origin. More...

ON_TextRunArray *	TextRuns (bool bRaw) const

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

const ON_wString	WrappedPlainText () const

const ON_wString	WrappedPlainTextWithFields () const

bool	WrapText (double width) const
	Wrap text to a specified width in model space. More...

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

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 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 bool	CreateStackedText (ON_TextRun *run)

static bool	CreateStackedText (ON_TextRun run, int cpcount, const ON__UINT32 cp, ON__UINT32 stack_delimiter=L'/')

static bool	EvaluateField (ON_TextRun *run)
	Evaluates the field instructions in the run and puts the results in run->m_display_string. More...

static int	FindAndStackFractions (ON_TextRunArray *runs, int i, ON_wString wstr)

static bool	FormatAngleMeasurement (double angle, const ON_DimStyle dimstyle, const wchar_t user_text, ON_wString &formatted_string)

static bool	FormatDistanceAndTolerance (double distance, ON::LengthUnitSystem units_in, const ON_DimStyle *dimstyle, bool alternate, ON_wString &formatted_string)
	Dimension text formatting. More...

static bool	FormatDistanceMeasurement (double distance_in, ON::LengthUnitSystem units_in, const ON_DimStyle dimstyle, const wchar_t user_text, ON_wString &formatted_string)

static double	GetLinefeedHeight (ON_TextRun &run)
	Returns the height in model units of the run, including text height and inter-line spacing More...

static bool	MeasureTextContent (ON_TextContent *text, bool raw, bool wrapped)
	Calculates the size, spacing and position of the runs in the ON_TextContent More...

static bool	MeasureTextRun (ON_TextRun *run)
	Calculates the size, spacing and position of the ON_TextRun within an ON_TextContent object More...

static bool	MeasureTextRunArray (ON_TextRunArray *runs, ON::TextVerticalAlignment v_align, ON::TextHorizontalAlignment h_align)
	Calculates the size, spacing and position of the runs in the ON_TextRunArray More...

Public Attributes
*bool IsCurrentDimStyle ON_DimStyle	const

Static Public Attributes
static const ON_TextContent	Empty

Static Public Attributes inherited from ON_Geometry
static const ON_Geometry	Unset

Friends
class	ON_Text

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...

Constructor & Destructor Documentation

◆ ON_TextContent() [1/2]

ON_TextContent::ON_TextContent ( )

default

◆ ~ON_TextContent()

ON_TextContent::~ON_TextContent ( )

◆ ON_TextContent() [2/2]

ON_TextContent::ON_TextContent ( const ON_TextContent & src )

Member Function Documentation

◆ ClearBoundingBox()

void ON_TextContent::ClearBoundingBox ( )

overridevirtual

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.

Generally, ClearBoundingBox() overrides simply invalidate a cached bounding box and then wait for a call to GetBBox() before recomputing the bounding box.

The default implementation does nothing.

Reimplemented from ON_Geometry.

◆ ComposeText()

bool ON_TextContent::ComposeText ( )

◆ Create() [1/2]

bool ON_TextContent::Create	(	const wchar_t *	RtfString,
		ON::AnnotationType	annotation_type,
		const ON_DimStyle *	dimstyle,
		bool	bWrapped,
		double	rect_width,
		double	text_rotation_radians
	)

Parses text string and makes runs.

◆ Create() [2/2]

bool ON_TextContent::Create	(	const wchar_t *	RtfString,
		ON::AnnotationType	annotation_type,
		const ON_DimStyle *	dimstyle
	)

◆ CreateStackedText() [1/2]

static bool ON_TextContent::CreateStackedText ( ON_TextRun * run )

static

◆ CreateStackedText() [2/2]

static bool ON_TextContent::CreateStackedText	(	ON_TextRun *	run,
		int	cpcount,
		const ON__UINT32 *	cp,
		ON__UINT32	stack_delimiter = `L'/'`
	)

static

◆ Dimension()

int ON_TextContent::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.

◆ DimStyleTextPositionPropertiesHash()

ON_SHA1_Hash ON_TextContent::DimStyleTextPositionPropertiesHash ( ) const

Returns: The value of ON_DimStyle.TextPositionPropertiesHash() of the ON_DimStyle passed to Create(), ReplaceTextString(), or RebuildRuns().

◆ Dump()

void ON_TextContent::Dump ( ON_TextLog & ) const

overridevirtual

virtual

Reimplemented from ON_Object.

◆ EqualTextPositionProperties()

bool ON_TextContent::EqualTextPositionProperties	(	ON::AnnotationType	annotation_type,
		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.

◆ EvaluateField()

static bool ON_TextContent::EvaluateField ( ON_TextRun * run )

static

Evaluates the field instructions in the run and puts the results in run->m_display_string.

TODODOC: [in/out] ON_TextRun& run - Run to evsluste. Modified to store results

Returns: true = Success false = Failure

The runs in the text are modified to store the string result of evaluating any fields in the run m_string or m_codepoints

◆ EvaluationSerialNumber()

unsigned int ON_TextContent::EvaluationSerialNumber ( ) const

◆ FindAndStackFractions()

static int ON_TextContent::FindAndStackFractions	(	ON_TextRunArray *	runs,
		int	i,
		ON_wString	wstr
	)

static

◆ FormatAngleMeasurement()

static bool ON_TextContent::FormatAngleMeasurement	(	double	angle,
		const ON_DimStyle *	dimstyle,
		const wchar_t *	user_text,
		ON_wString &	formatted_string
	)

static

◆ FormatDistanceAndTolerance()

static bool ON_TextContent::FormatDistanceAndTolerance	(	double	distance,
		ON::LengthUnitSystem	units_in,
		const ON_DimStyle *	dimstyle,
		bool	alternate,
		ON_wString &	formatted_string
	)

static

Dimension text formatting.

◆ FormatDistanceMeasurement()

static bool ON_TextContent::FormatDistanceMeasurement	(	double	distance_in,
		ON::LengthUnitSystem	units_in,
		const ON_DimStyle *	dimstyle,
		const wchar_t *	user_text,
		ON_wString &	formatted_string
	)

static

◆ FormattingRectangleWidth()

double ON_TextContent::FormattingRectangleWidth ( ) const

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

◆ Get2dCorners()

bool ON_TextContent::Get2dCorners ( ON_2dPoint corners[4] ) const

◆ Get2dPickMesh()

ON_Mesh* ON_TextContent::Get2dPickMesh ( ) const

◆ Get2dSize()

bool ON_TextContent::Get2dSize	(	bool	raw,
		double &	width,
		double &	height
	)		const

Get the size of a 2d rectangle enclosing text.

◆ Get3dCorners()

bool ON_TextContent::Get3dCorners ( ON_3dPoint corners[4] ) const

◆ Get3dMaskCorners()

bool ON_TextContent::Get3dMaskCorners	(	double	border,
		ON_3dPoint	corners[4]
	)		const

◆ Get3dPickMesh()

ON_Mesh* ON_TextContent::Get3dPickMesh ( ) const

◆ Get3dUnderline()

bool ON_TextContent::Get3dUnderline	(	ON_3dPoint	ends[2],
		double	scaled_gap
	)		const

Gets endpoints of a line under the text offset down by textgap.

◆ GetAlignment()

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

◆ GetBBox()

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

overridevirtual

virtual ON_Geometry GetBBox override

Reimplemented from ON_Geometry.

◆ GetGlyphContours() [1/2]

bool ON_TextContent::GetGlyphContours	(	const ON_Font *	text_font,
		bool	bSingleStrokeFont,
		double	text_height,
		ON_ClassArray< ON_ClassArray< ON_SimpleArray< ON_Curve * > > > &	text_contours
	)		const

◆ GetGlyphContours() [2/2]

bool ON_TextContent::GetGlyphContours	(	const ON_Font *	text_font,
		bool	bSingleStrokeFont,
		const ON_Xform &	text_xform,
		ON_ClassArray< ON_ClassArray< ON_SimpleArray< ON_Curve * > > > &	text_contours
	)		const

◆ GetGripPoints()

void ON_TextContent::GetGripPoints	(	ON_2dPoint &	base,
		ON_2dPoint &	width
	)		const

returns the base point and with grip using the current alignments

◆ GetLinefeedHeight()

static double ON_TextContent::GetLinefeedHeight ( ON_TextRun & run )

static

Returns the height in model units of the run, including text height and inter-line spacing

◆ GetRun3dCorners()

bool ON_TextContent::GetRun3dCorners	(	const ON_TextRun *	run,
		ON_3dPoint	corners[4]
	)		const

◆ HasWrappedRuns()

bool ON_TextContent::HasWrappedRuns ( ) const

True if text has wrapped runs, else false.

◆ IsValid()

bool ON_TextContent::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_Geometry.

◆ MeasureTextContent()

static bool ON_TextContent::MeasureTextContent	(	ON_TextContent *	text,
		bool	raw,
		bool	wrapped
	)

static

Calculates the size, spacing and position of the runs in the ON_TextContent

TODODOC: [in/out] ON_TextContent& text - Text to measure. Modified to store results TODODOC: [in] bool raw - if true, measure m_runs TODODOC: [in] bool wrapped - if true, measure m_wrapped_runs

Returns: true = Success false = Failure

The runs in the text are modified to store the location info for positioning within the text object

◆ MeasureTextRun()

static bool ON_TextContent::MeasureTextRun ( ON_TextRun * run )

static

Calculates the size, spacing and position of the ON_TextRun within an ON_TextContent object

TODODOC: [in/out] ON_TextRun& run - Run to measure. Modified to store results

Returns: true = Success false = Failure

The runs in the text are modified to store the location info for positioning within the text object

◆ MeasureTextRunArray()

static bool ON_TextContent::MeasureTextRunArray	(	ON_TextRunArray *	runs,
		ON::TextVerticalAlignment	v_align,
		ON::TextHorizontalAlignment	h_align
	)

static

Calculates the size, spacing and position of the runs in the ON_TextRunArray

TODODOC: [in/out] ON_TextRunArray* runs - TextRuns to measure. Modified to store results TODODOC: [in] ON::TextVerticalAlignment v_align - how to align the text TODODOC: [in] ON::TextHorizontalAlignment h_align)

Returns: true = Success false = Failure

The runs in the text are modified to store the location info for positioning within the text object

◆ ObjectType()

ON::object_type ON_TextContent::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.

◆ operator=()

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

◆ PlainText()

const ON_wString ON_TextContent::PlainText ( ) const

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

◆ PlainTextWithFields()

const ON_wString ON_TextContent::PlainTextWithFields ( ) const

Returns: Plain text information with any rich text formatting instructions removed. Fields are not evaluated

◆ Read()

bool ON_TextContent::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.

◆ RealignTextRuns()

void ON_TextContent::RealignTextRuns ( ON::TextHorizontalAlignment new_h_align )

◆ RebuildRuns()

bool ON_TextContent::RebuildRuns	(	ON::AnnotationType	annotation_type,
		const ON_DimStyle *	dimstyle
	)

◆ ReplaceTextString()

bool ON_TextContent::ReplaceTextString	(	const wchar_t *	RtfString,
		ON::AnnotationType	annotation_type,
		const ON_DimStyle *	dimstyle
	)

◆ RichText()

const ON_wString ON_TextContent::RichText ( ) const

Returns: Raw text that can contain rich text formatting instructions. Fields are not evaluated.

◆ RtfText()

const wchar_t* ON_TextContent::RtfText ( ) const

◆ SetAlignment()

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

◆ SetEvaluationSerialNumber()

void ON_TextContent::SetEvaluationSerialNumber ( unsigned int sn ) const

◆ SetFormattingRectangleWidth()

void ON_TextContent::SetFormattingRectangleWidth ( double width )

◆ SetTextIsWrapped()

void ON_TextContent::SetTextIsWrapped ( bool wrapped )

◆ SetTextRotationDegrees()

void ON_TextContent::SetTextRotationDegrees ( double rotation )

◆ SetTextRotationRadians()

void ON_TextContent::SetTextRotationRadians ( double rotation )

◆ TextContentBoundingBox()

const ON_BoundingBox ON_TextContent::TextContentBoundingBox ( ) const

◆ TextContentHash() [1/2]

ON_SHA1_Hash ON_TextContent::TextContentHash ( ) const

Returns: A hash of the information that determines the text content using wrapped text with evaluated fields.

◆ TextContentHash() [2/2]

ON_SHA1_Hash ON_TextContent::TextContentHash	(	bool	bApplyWrapping,
		bool	bEvaluateFields
	)		const

Parameters

bApplyWrapping	[in]
true	hash wrapped text
false	has unwrapped text
bEvaluateFields	[in]
true	hash text with fields evaluated
false	hash text with fields unevaluated

Returns: A hash of the information that determines the text content without evaluating the fields.

◆ TextIsWrapped()

bool ON_TextContent::TextIsWrapped ( ) const

True if flag to wrap is set.

◆ TextRotationDegrees()

double ON_TextContent::TextRotationDegrees ( ) const

Rotation in degrees around origin.

◆ TextRotationRadians()

double ON_TextContent::TextRotationRadians ( ) const

Rotation in radians around origin.

◆ TextRuns()

ON_TextRunArray* ON_TextContent::TextRuns ( bool bRaw ) const

◆ Transform()

bool ON_TextContent::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.

◆ WrappedPlainText()

const ON_wString ON_TextContent::WrappedPlainText ( ) const

◆ WrappedPlainTextWithFields()

const ON_wString ON_TextContent::WrappedPlainTextWithFields ( ) const

◆ WrapText()

bool ON_TextContent::WrapText ( double width ) const

Wrap text to a specified width in model space.

◆ Write()

bool ON_TextContent::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.

Friends And Related Function Documentation

◆ ON_Text

friend class ON_Text

friend

Member Data Documentation

◆ const

* bool IsCurrentDimStyle ON_DimStyle ON_TextContent::const

Parameters

dimsytle [in]

Returns
true if style was passed as dimstyle paramter to Create(), ReplaceTextString(), or RebuildRuns() and used to create the current text runs.

◆ Empty

const ON_TextContent ON_TextContent::Empty

static

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ ON_TextContent() [1/2]

◆ ~ON_TextContent()

◆ ON_TextContent() [2/2]

Member Function Documentation

◆ ClearBoundingBox()

◆ ComposeText()

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateStackedText() [1/2]

◆ CreateStackedText() [2/2]

◆ Dimension()

◆ DimStyleTextPositionPropertiesHash()

◆ Dump()

◆ EqualTextPositionProperties()

◆ EvaluateField()

◆ EvaluationSerialNumber()

◆ FindAndStackFractions()

◆ FormatAngleMeasurement()

◆ FormatDistanceAndTolerance()

◆ FormatDistanceMeasurement()

◆ FormattingRectangleWidth()

◆ Get2dCorners()

◆ Get2dPickMesh()

◆ Get2dSize()

◆ Get3dCorners()

◆ Get3dMaskCorners()

◆ Get3dPickMesh()

◆ Get3dUnderline()

◆ GetAlignment()

◆ GetBBox()

◆ GetGlyphContours() [1/2]

◆ GetGlyphContours() [2/2]

◆ GetGripPoints()

◆ GetLinefeedHeight()

◆ GetRun3dCorners()

◆ HasWrappedRuns()

◆ IsValid()

◆ MeasureTextContent()

◆ MeasureTextRun()

◆ MeasureTextRunArray()

◆ ObjectType()

◆ operator=()

◆ PlainText()

◆ PlainTextWithFields()

◆ Read()

◆ RealignTextRuns()

◆ RebuildRuns()

◆ ReplaceTextString()

◆ RichText()

◆ RtfText()

◆ SetAlignment()

◆ SetEvaluationSerialNumber()

◆ SetFormattingRectangleWidth()

◆ SetTextIsWrapped()

◆ SetTextRotationDegrees()

◆ SetTextRotationRadians()

◆ TextContentBoundingBox()

◆ TextContentHash() [1/2]

◆ TextContentHash() [2/2]

◆ TextIsWrapped()

◆ TextRotationDegrees()

◆ TextRotationRadians()

◆ TextRuns()

◆ Transform()

◆ WrappedPlainText()

◆ WrappedPlainTextWithFields()

◆ WrapText()

◆ Write()

Friends And Related Function Documentation

◆ ON_Text

Member Data Documentation

◆ const

◆ Empty