ON_Annotation Class Reference

#include <opennurbs_annotation.h>

Inheritance diagram for ON_Annotation:

Public Member Functions
void	Create ()
const ON_wString &	DefaultText () const
void	Destroy ()
int	Dimension () const
void	Dump (ON_TextLog &) const
void	EmergencyDestroy ()
ON_BOOL32	GetBBox (double *, double *, ON_BOOL32=false) const
bool	GetECStoWCSXform (ON_Xform &xform) const
bool	GeWCStoECSXform (ON_Xform &xform) const
bool	IsDimension () const
bool	IsLeader () const
virtual ON_BOOL32	IsRealObject () const =0
bool	IsText () const
ON_BOOL32	IsValid (ON_TextLog *text_log=NULL) const
virtual double	NumericValue () const
ON::object_type	ObjectType () const
	ON_Annotation ()
	ON_Annotation (const ON_Annotation &)
ON_Annotation &	operator= (const ON_Annotation &)
ON_Plane	Plane () const
ON_2dPoint	Point (int idx) const
int	PointCount () const
const ON_SimpleArray< ON_2dPoint > &	Points () const
ON_BOOL32	Read (ON_BinaryArchive &)
void	SetDefaultText (const wchar_t *string)
void	SetPlane (const ON_Plane &plane)
void	SetPoint (int idx, ON_3dPoint point)
void	SetPoints (const ON_SimpleArray< ON_2dPoint > &points)
void	SetTextDisplayMode (ON::eTextDisplayMode mode)
virtual void	SetTextToDefault ()
void	SetType (ON::eAnnotationType type)
void	SetUserPositionedText (int bUserPositionedText)
void	SetUserText (const wchar_t *string)
ON::eTextDisplayMode	TextDisplayMode () const
ON_BOOL32	Transform (const ON_Xform &)
ON::eAnnotationType	Type () const
bool	UserPositionedText () const
const ON_wString &	UserText () const
ON_BOOL32	Write (ON_BinaryArchive &) const
	~ON_Annotation ()
Public Member Functions inherited from ON_Geometry
ON_BoundingBox	BoundingBox () const
virtual ON_Brep *	BrepForm (ON_Brep *brep=NULL) const
virtual void	ClearBoundingBox ()
virtual ON_COMPONENT_INDEX	ComponentIndex () const
virtual bool	EvaluatePoint (const class ON_ObjRef &objref, ON_3dPoint &P) const
ON_BOOL32	GetBoundingBox (ON_3dPoint &bbox_min, ON_3dPoint &bbox_max, int bGrowBox=false) const
ON_BOOL32	GetBoundingBox (ON_BoundingBox &bbox, int bGrowBox=false) const
virtual bool	GetTightBoundingBox (ON_BoundingBox &tight_bbox, int bGrowBox=false, const ON_Xform *xform=0) const
virtual ON_BOOL32	HasBrepForm () const
virtual bool	IsDeformable () const
virtual bool	IsMorphable () const
virtual bool	MakeDeformable ()
virtual bool	Morph (const ON_SpaceMorph &morph)
	ON_Geometry ()
	ON_Geometry (const ON_Geometry &)
ON_Geometry &	operator= (const ON_Geometry &)
ON_BOOL32	Rotate (double rotation_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
ON_BOOL32	Rotate (double sin_angle, double cos_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
ON_BOOL32	Scale (double scale_factor)
virtual ON_BOOL32	SwapCoordinates (int i, int j)
ON_BOOL32	Translate (const ON_3dVector &translation_vector)
virtual	~ON_Geometry ()
Public Member Functions inherited from ON_Object
ON_BOOL32	AttachUserData (ON_UserData *pUserData)
bool	CopyFrom (const ON_Object *src)
void	CopyUserData (const ON_Object &source_object)
virtual ON__UINT32	DataCRC (ON__UINT32 current_remainder) const
virtual void	DestroyRuntimeCache (bool bDelete=true)
ON_BOOL32	DetachUserData (ON_UserData *pUserData)
ON_UserData *	FirstUserData () const
ON_UserData *	GetUserData (const ON_UUID &userdata_uuid) const
bool	GetUserString (const wchar_t *key, ON_wString &string_value) const
int	GetUserStringKeys (ON_ClassArray< ON_wString > &user_string_keys) const
int	GetUserStrings (ON_ClassArray< ON_UserString > &user_strings) const
ON_BOOL32	IsKindOf (const ON_ClassId *pClassId) const
virtual void	MemoryRelocate ()
virtual ON_UUID	ModelObjectId () const
void	MoveUserData (ON_Object &source_object)
	ON_Object ()
	ON_Object (const ON_Object &)
ON_Object &	operator= (const ON_Object &)
void	PurgeUserData ()
bool	SetUserString (const wchar_t *key, const wchar_t *string_value)
virtual unsigned int	SizeOf () const
void	TransformUserData (const ON_Xform &xform)
virtual	~ON_Object ()

Static Public Member Functions
static const ON_3dmAnnotationSettings &	AnnotationSettings ()
static void	SetAnnotationSettings (const ON_3dmAnnotationSettings *)

Public Attributes
ON_wString	m_defaulttext
ON_Plane	m_plane
ON_SimpleArray< ON_2dPoint >	m_points
ON::eTextDisplayMode	m_textdisplaymode
ON::eAnnotationType	m_type
bool	m_userpositionedtext
ON_wString	m_usertext
Public Attributes inherited from ON_Object
ON_MEMORY_POOL *	m_mempool

Private Types
enum	SYMBOLS { degreesym = 176 , radiussym = 'R' , diametersym = 216 , plusminussym = 177 }

Private Member Functions
	ON_OBJECT_DECLARE (ON_Annotation)

Member Enumeration Documentation

SYMBOLS

enum ON_Annotation::SYMBOLS

private

Enumerator
degreesym
radiussym
diametersym
plusminussym

Constructor & Destructor Documentation

ON_Annotation() [1/2]

ON_Annotation::ON_Annotation

(

)

ON_Annotation() [2/2]

ON_Annotation::ON_Annotation

(

const ON_Annotation &

src

)

~ON_Annotation()

ON_Annotation::~ON_Annotation

(

)

Member Function Documentation

AnnotationSettings()

const ON_3dmAnnotationSettings & ON_Annotation::AnnotationSettings ( )

static

Create()

void ON_Annotation::Create

(

)

DefaultText()

const ON_wString & ON_Annotation::DefaultText

(

)

const

Destroy()

void ON_Annotation::Destroy

(

)

Dimension()

int ON_Annotation::Dimension ( ) const

virtual

Implements ON_Geometry.

Dump()

void ON_Annotation::Dump ( ON_TextLog & dump ) const

virtual

Reimplemented from ON_Object.

EmergencyDestroy()

void ON_Annotation::EmergencyDestroy

(

)

GetBBox()

ON_BOOL32 ON_Annotation::GetBBox ( double * boxmin, double * boxmax, ON_BOOL32 bGrowBox = false ) const

virtual

Implements ON_Geometry.

GetECStoWCSXform()

bool ON_Annotation::GetECStoWCSXform

(

ON_Xform &

xform

)

const

GeWCStoECSXform()

bool ON_Annotation::GeWCStoECSXform

(

ON_Xform &

xform

)

const

IsDimension()

bool ON_Annotation::IsDimension

(

)

const

IsLeader()

bool ON_Annotation::IsLeader

(

)

const

IsRealObject()

virtual ON_BOOL32 ON_Annotation::IsRealObject ( ) const

pure virtual

Implemented in ON_LinearDimension, ON_RadialDimension, ON_AngularDimension, ON_TextEntity, and ON_Leader.

IsText()

bool ON_Annotation::IsText

(

)

const

IsValid()

ON_BOOL32 ON_Annotation::IsValid ( ON_TextLog * text_log = NULL ) const

virtual

Implements ON_Object.

NumericValue()

double ON_Annotation::NumericValue ( ) const

virtual

ObjectType()

ON::object_type ON_Annotation::ObjectType ( ) const

virtual

Reimplemented from ON_Object.

ON_OBJECT_DECLARE()

ON_Annotation::ON_OBJECT_DECLARE ( ON_Annotation )

private

operator=()

ON_Annotation & ON_Annotation::operator=

(

const ON_Annotation &

src

)

Plane()

ON_Plane ON_Annotation::Plane

(

)

const

Point()

ON_2dPoint ON_Annotation::Point

(

int

idx

)

const

PointCount()

int ON_Annotation::PointCount

(

)

const

Points()

const ON_SimpleArray< ON_2dPoint > & ON_Annotation::Points

(

)

const

Read()

ON_BOOL32 ON_Annotation::Read ( ON_BinaryArchive & file )

virtual

Reimplemented from ON_Object.

Reimplemented in ON_TextEntity.

SetAnnotationSettings()

void ON_Annotation::SetAnnotationSettings ( const ON_3dmAnnotationSettings * p )

static

SetDefaultText()

void ON_Annotation::SetDefaultText

(

const wchar_t *

string

)

SetPlane()

void ON_Annotation::SetPlane

(

const ON_Plane &

plane

)

SetPoint()

void ON_Annotation::SetPoint	(	int	idx,
		ON_3dPoint	point )

SetPoints()

void ON_Annotation::SetPoints

(

const ON_SimpleArray< ON_2dPoint > &

points

)

SetTextDisplayMode()

void ON_Annotation::SetTextDisplayMode

(

ON::eTextDisplayMode

mode

)

SetTextToDefault()

void ON_Annotation::SetTextToDefault ( )

virtual

Reimplemented in ON_LinearDimension, ON_RadialDimension, and ON_AngularDimension.

SetType()

void ON_Annotation::SetType

(

ON::eAnnotationType

type

)

SetUserPositionedText()

void ON_Annotation::SetUserPositionedText

(

int

bUserPositionedText

)

SetUserText()

void ON_Annotation::SetUserText

(

const wchar_t *

string

)

TextDisplayMode()

ON::eTextDisplayMode ON_Annotation::TextDisplayMode

(

)

const

Transform()

ON_BOOL32 ON_Annotation::Transform ( const ON_Xform & xform )

virtual

Reimplemented from ON_Geometry.

Type()

ON::eAnnotationType ON_Annotation::Type

(

)

const

UserPositionedText()

bool ON_Annotation::UserPositionedText

(

)

const

UserText()

const ON_wString & ON_Annotation::UserText

(

)

const

Write()

ON_BOOL32 ON_Annotation::Write ( ON_BinaryArchive & file ) const

virtual

Reimplemented from ON_Object.

Reimplemented in ON_TextEntity.

Member Data Documentation

m_defaulttext

ON_wString ON_Annotation::m_defaulttext

m_plane

ON_Plane ON_Annotation::m_plane

m_points

ON_SimpleArray<ON_2dPoint> ON_Annotation::m_points

m_textdisplaymode

ON::eTextDisplayMode ON_Annotation::m_textdisplaymode

m_type

ON::eAnnotationType ON_Annotation::m_type

m_userpositionedtext

bool ON_Annotation::m_userpositionedtext

m_usertext

ON_wString ON_Annotation::m_usertext

---

The documentation for this class was generated from the following files:

• src/3rdparty/legacy/opennurbs/opennurbs_annotation.h
• src/3rdparty/legacy/opennurbs/opennurbs_annotation.cpp