OdBmGRichText Class

Class Hierarchy

Syntax

C++

class OdBmGRichText : public OdBmGNode;

File

BmGRichText.h

Description

This class stores geometry data of rich (formatted) text.

Group

Geometry Classes

Public Methods

OdBmObject Class

	Name	Description
	~OdBmObject	A destructor for the BimRv object.

OdTfObject Methods

	Name	Description
	addPersistentReactor	Adds a new persistent reactor object to the element's reactor list.
	addReactor	Adds a new transient reactor object to the element's reactor list.
	getOwner	Retrieves the object's owner object.
	getPersistentReactors	Retrieves all the persistent reactors from the element.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getTransientReactors	Retrieves all the transient reactors from the element.
	hasPersistentReactor	Retrieves whether a specified persistent reactor object is attached to the element.
	removePersistentReactor	Removes a specified persistent reactor object from the element's reactor list.
	removeReactor	Removes a specified transient reactor object from the element's reactor list.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.

OdBmObject Class

	Name	Description
	addPersistentReactor	Adds a new persistent reactor object to the element's reactor list.
	addReactor	Adds a new transient reactor object to the element's reactor list.
	addRef	Increments the counter of references to the object.
	clone	Clones the object.
	database	Retrieves the related database object.
	drawableType	Retrieves the drawable type of the object.
	getGeomExtents	Returns a WCS bounding box that represents the extents of this object.
	getListParams	Retrieves the list of built-in parameters.
	getOwner	Retrieves the object's owner object.
	getPersistentReactors	Retrieves all the persistent reactors from the element.
	getProperties	Retrieves the array of object's properties.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getTransientReactors	Retrieves all the transient reactors from the element.
	gsNode	Retrieves graphical system cache associated with the object.
	hasPersistentReactor	Retrieves whether a specified persistent reactor object is attached to the element.
	id	Retrieves the object's identifier in the associated database.
	isPersistent	Retrieves whether the object is persistent or not.
	numRefs	Retrieves the current quantity of references to the object.
	release	Decrements the counter of references to the object. When the counter becomes equal to zero the object is destroyed.
	removePersistentReactor	Removes a specified persistent reactor object from the element's reactor list.
	removeReactor	Removes a specified transient reactor object from the element's reactor list.
	setDatabaseDefaults	Applies the default properties of the specified database to this entity.
	setGsNode	Assigns the specified OdGsCache to this object.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	subRegenSupportFlags	Retrieves the current regeneration support flags set for the object.
	subSetAttributes	Sets the vectorization attributes of the object, and returns its attribute flags.
	subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set.
	subViewportDraw	Implements viewport-dependent rendering.
	subWorldDraw	Implements the mechanism for rendering the object.

OdBmGNode Class

	Name	Description
	getCategoryId	Returns the ID of a category as an object of the OdBmObjectId class.
	getControlCommand	Returns the control command as an OdInt32 value.
	getGInfo	Returns the geometry information as an OdBmGInfo object.
	getGInfoFlags	Returns the set of bit flags as an OdUInt32 value.
	getGNodeByMarker	Returns GNode by GsMarker.
	getGsMarker	Returns GsMarker for current GNode.
	getGStyleId	Guaranteed return id referenced to GStyleElem
	getTag	Returns the object tag as an OdInt32 value.
	getVisibility	Returns the visibility of BmGNode.
	hasGStyle	This is hasGStyle, a member of class OdBmGNode.
	resetGInfoFlag	This is resetGInfoFlag, a member of class OdBmGNode.
	setCategoryId	Sets a category ID to this object.
	setControlCommand	Sets a control command to this object.
	setGInfoFlag	This is setGInfoFlag, a member of class OdBmGNode.
	setGInfoFlags	Sets object bit flags.
	setModelGNode	Sets the model flag to this object.
	setTag	Sets an object tag.

OdBmGRichText Class

	Name	Description
	getArrRtfRawData	Returns the array of RTF raw data.
	getBorderOffset	Returns the border offset as a double value.
	getDefaultFontName	Returns the dafault font name as an OdString value.
	getDefaultFontSize	Returns the default font size as a double value.
	getDefaultHorizontalTextAlignment	Returns the default alignment of horizontal text as an OdInt32 value.
	getDefaultTabSize	Returns the default tab size as a double value.
	getDefaultTextColor	Returns the default text color as an OdBmCmColor value.
	getDefaultVerticalTextAlignment	Returns the default alignment of vertical text as an OdInt32 value.
	getDrawPrehiliteBox	Returns true if a prehilite box will be drawn.
	getIsDefaultFontBold	Returns true if the default font is bold.
	getIsDefaultFontItalic	Returns true if the default font is italic.
	getIsDefaultFontUnderlined	Returns true if the default font is underlined.
	getKeepReadable	Returns true if the text object will be kept readable.
	getLayoutHeightHimetric	Returns the layout height himetric as an OdInt32 value.
	getLayoutWidthHimetric	Returns the layout width himetric as an OdInt32 value.
	getLeftOverhangRatio	Returns the left overhang ratio as a double value.
	getModelOrigin	Returns the model origin point as an object of the OdGePoint3d class.
	getModelToSheetScale	Returns the 'model to sheet' scale as a double value.
	getModelXUnitVec	Returns the model X-Vector as an object of the OdGeVector3d class.
	getModelYUnitVec	Returns the model Y-Vector as an object of the OdGeVector3d class.
	getNoWrapping	Returns true if the text object has no wrapping.
	getPickWithBorderOffset	This is getPickWithBorderOffset, a member of class OdBmGRichText.
	getRightOverhangRatio	Returns the right overhang ratio as a double value.
	getTextHeightHimetric	Returns the text height himetric as an OdInt32 value.
	getTextHorzOffsetHimetric	Returns the himetric of the text's horizontal offset as an OdInt32 value.
	getTextVertOffsetHimetric	Returns the himeric of the text's vertical offset as an OdInt32 value.
	getTextWidthHimetric	Returns the text width himetric as an OdInt32 value.
	getTransparentBackground	Returns true if the background is transparrent.
	getUseModelVecsIn3D	This is getUseModelVecsIn3D, a member of class OdBmGRichText.
	getWidthScale	Returns the width scale as a double value.

OdBmObject Nested Types

OdBmObject Class

Name	Description
ItemIndexType	This is nested type OdBmObject::ItemIndexType.
PropertyIndexType	This is nested type OdBmObject::PropertyIndexType.

Send feedback about this topic