ON_Annotation Class Reference

#include <opennurbs_annotation.h>

Inheritance diagram for ON_Annotation:

List of all members.

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 ()
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
Private Types
enum	SYMBOLS { degreesym = 176, radiussym = 'R', diametersym = 216, plusminussym = 177 }
Private Member Functions
	ON_OBJECT_DECLARE (ON_Annotation)

---

Detailed Description

Definition at line 154 of file opennurbs_annotation.h.

---

Member Enumeration Documentation

enum ON_Annotation::SYMBOLS [private]

Enumerator:

degreesym
radiussym
diametersym
plusminussym

Definition at line 158 of file opennurbs_annotation.h.

---

Constructor & Destructor Documentation

ON_Annotation::ON_Annotation

(

)

Definition at line 79 of file opennurbs_annotation.cpp.

ON_Annotation::ON_Annotation

(

const ON_Annotation &

src

)

Definition at line 84 of file opennurbs_annotation.cpp.

ON_Annotation::~ON_Annotation

(

)

Definition at line 90 of file opennurbs_annotation.cpp.

---

Member Function Documentation

const ON_3dmAnnotationSettings & ON_Annotation::AnnotationSettings

(

)

[static]

Definition at line 41 of file opennurbs_annotation.cpp.

void ON_Annotation::Create

(

)

Definition at line 47 of file opennurbs_annotation.cpp.

const ON_wString & ON_Annotation::DefaultText

(

)

const

Definition at line 118 of file opennurbs_annotation.cpp.

void ON_Annotation::Destroy

(

)

Definition at line 59 of file opennurbs_annotation.cpp.

int ON_Annotation::Dimension

(

)

const [virtual]

Implements ON_Geometry.

Definition at line 235 of file opennurbs_annotation.cpp.

void ON_Annotation::Dump

(

ON_TextLog &

dump

)

const [virtual]

Reimplemented from ON_Object.

Definition at line 154 of file opennurbs_annotation.cpp.

void ON_Annotation::EmergencyDestroy

(

)

Reimplemented from ON_Object.

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

Definition at line 69 of file opennurbs_annotation.cpp.

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

Implements ON_Geometry.

Definition at line 240 of file opennurbs_annotation.cpp.

bool ON_Annotation::GetECStoWCSXform

(

ON_Xform &

xform

)

const

Definition at line 291 of file opennurbs_annotation.cpp.

bool ON_Annotation::GeWCStoECSXform

(

ON_Xform &

xform

)

const

Definition at line 299 of file opennurbs_annotation.cpp.

bool ON_Annotation::IsDimension

(

)

const

Definition at line 98 of file opennurbs_annotation.cpp.

bool ON_Annotation::IsLeader

(

)

const

Definition at line 97 of file opennurbs_annotation.cpp.

virtual ON_BOOL32 ON_Annotation::IsRealObject

(

)

const [pure virtual]

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

bool ON_Annotation::IsText

(

)

const

Definition at line 96 of file opennurbs_annotation.cpp.

ON_BOOL32 ON_Annotation::IsValid

(

ON_TextLog *

text_log = NULL

)

const [virtual]

Implements ON_Object.

Definition at line 141 of file opennurbs_annotation.cpp.

double ON_Annotation::NumericValue

(

)

const [virtual]

Definition at line 101 of file opennurbs_annotation.cpp.

ON::object_type ON_Annotation::ObjectType

(

)

const [virtual]

Reimplemented from ON_Object.

Definition at line 228 of file opennurbs_annotation.cpp.

ON_Annotation::ON_OBJECT_DECLARE

(

ON_Annotation

)

[private]

ON_Annotation & ON_Annotation::operator=

(

const ON_Annotation &

src

)

Definition at line 123 of file opennurbs_annotation.cpp.

ON_Plane ON_Annotation::Plane

(

)

const

Definition at line 111 of file opennurbs_annotation.cpp.

ON_2dPoint ON_Annotation::Point

(

int

idx

)

const

Definition at line 312 of file opennurbs_annotation.cpp.

int ON_Annotation::PointCount

(

)

const

Definition at line 112 of file opennurbs_annotation.cpp.

const ON_SimpleArray< ON_2dPoint > & ON_Annotation::Points

(

)

const

Definition at line 114 of file opennurbs_annotation.cpp.

ON_BOOL32 ON_Annotation::Read

(

ON_BinaryArchive &

file

)

[virtual]

Reimplemented from ON_Object.

Reimplemented in ON_TextEntity, and ON_AngularDimension.

Definition at line 185 of file opennurbs_annotation.cpp.

void ON_Annotation::SetAnnotationSettings

(

const ON_3dmAnnotationSettings *

p

)

[static]

Definition at line 36 of file opennurbs_annotation.cpp.

void ON_Annotation::SetDefaultText

(

const wchar_t *

string

)

Definition at line 117 of file opennurbs_annotation.cpp.

void ON_Annotation::SetPlane

(

const ON_Plane &

plane

)

Definition at line 110 of file opennurbs_annotation.cpp.

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

Definition at line 306 of file opennurbs_annotation.cpp.

void ON_Annotation::SetPoints

(

const ON_SimpleArray< ON_2dPoint > &

points

)

Definition at line 113 of file opennurbs_annotation.cpp.

void ON_Annotation::SetTextDisplayMode

(

ON::eTextDisplayMode

mode

)

Definition at line 107 of file opennurbs_annotation.cpp.

void ON_Annotation::SetTextToDefault

(

)

[virtual]

Reimplemented in ON_AngularDimension, ON_RadialDimension, and ON_LinearDimension.

Definition at line 103 of file opennurbs_annotation.cpp.

void ON_Annotation::SetType

(

ON::eAnnotationType

type

)

Definition at line 105 of file opennurbs_annotation.cpp.

void ON_Annotation::SetUserPositionedText

(

int

bUserPositionedText

)

Definition at line 119 of file opennurbs_annotation.cpp.

void ON_Annotation::SetUserText

(

const wchar_t *

string

)

Definition at line 115 of file opennurbs_annotation.cpp.

ON::eTextDisplayMode ON_Annotation::TextDisplayMode

(

)

const

Definition at line 108 of file opennurbs_annotation.cpp.

ON_BOOL32 ON_Annotation::Transform

(

const ON_Xform &

xform

)

[virtual]

Reimplemented from ON_Geometry.

Definition at line 282 of file opennurbs_annotation.cpp.

ON::eAnnotationType ON_Annotation::Type

(

)

const

Definition at line 106 of file opennurbs_annotation.cpp.

bool ON_Annotation::UserPositionedText

(

)

const

Definition at line 120 of file opennurbs_annotation.cpp.

const ON_wString & ON_Annotation::UserText

(

)

const

Definition at line 116 of file opennurbs_annotation.cpp.

ON_BOOL32 ON_Annotation::Write

(

ON_BinaryArchive &

file

)

const [virtual]

Reimplemented from ON_Object.

Reimplemented in ON_TextEntity, and ON_AngularDimension.

Definition at line 160 of file opennurbs_annotation.cpp.

---

Member Data Documentation

ON_wString ON_Annotation::m_defaulttext

Definition at line 286 of file opennurbs_annotation.h.

ON_Plane ON_Annotation::m_plane

Definition at line 282 of file opennurbs_annotation.h.

ON_SimpleArray<ON_2dPoint> ON_Annotation::m_points

Definition at line 283 of file opennurbs_annotation.h.

ON::eTextDisplayMode ON_Annotation::m_textdisplaymode

Definition at line 279 of file opennurbs_annotation.h.

ON::eAnnotationType ON_Annotation::m_type

Definition at line 276 of file opennurbs_annotation.h.

bool ON_Annotation::m_userpositionedtext

Definition at line 288 of file opennurbs_annotation.h.

ON_wString ON_Annotation::m_usertext

Definition at line 285 of file opennurbs_annotation.h.

---

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

• opennurbs_annotation.h
• opennurbs_annotation.cpp