XCAFNoteObjects_NoteObject Class Reference

object to store note auxiliary data More...

#include <XCAFNoteObjects_NoteObject.hxx>

Inheritance diagram for XCAFNoteObjects_NoteObject:

Public Member Functions
	XCAFNoteObjects_NoteObject ()
	Empty object.
	XCAFNoteObjects_NoteObject (const Handle< XCAFNoteObjects_NoteObject > &theObj)
	Copy constructor.
Standard_Boolean	HasPlane () const
	Returns True if plane is specified.
const gp_Ax2 &	GetPlane () const
	Returns a right-handed coordinate system of the plane.
void	SetPlane (const gp_Ax2 &thePlane)
	Sets a right-handed coordinate system of the plane.
Standard_Boolean	HasPoint () const
	Returns True if the attachment point on the annotated object is specified.
const gp_Pnt &	GetPoint () const
	Returns the attachment point on the annotated object.
void	SetPoint (const gp_Pnt &thePnt)
	Sets the anchor point on the annotated object.
Standard_Boolean	HasPointText () const
	Returns True if the text position is specified.
const gp_Pnt &	GetPointText () const
	Returns the text position.
void	SetPointText (const gp_Pnt &thePnt)
	Sets the text position.
const TopoDS_Shape &	GetPresentation () const
	Returns a tessellated annotation if specified.
void	SetPresentation (const TopoDS_Shape &thePresentation)
	Sets a tessellated annotation.
void	Reset ()
	Resets data to the state after calling the default constructor.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

object to store note auxiliary data

Constructor & Destructor Documentation

XCAFNoteObjects_NoteObject() [1/2]

XCAFNoteObjects_NoteObject::XCAFNoteObjects_NoteObject

(

)

Empty object.

XCAFNoteObjects_NoteObject() [2/2]

XCAFNoteObjects_NoteObject::XCAFNoteObjects_NoteObject

(

const Handle< XCAFNoteObjects_NoteObject > &

theObj

)

Copy constructor.

Member Function Documentation

GetPlane()

const gp_Ax2 & XCAFNoteObjects_NoteObject::GetPlane ( ) const

inline

Returns a right-handed coordinate system of the plane.

GetPoint()

const gp_Pnt & XCAFNoteObjects_NoteObject::GetPoint ( ) const

inline

Returns the attachment point on the annotated object.

GetPointText()

const gp_Pnt & XCAFNoteObjects_NoteObject::GetPointText ( ) const

inline

Returns the text position.

GetPresentation()

const TopoDS_Shape & XCAFNoteObjects_NoteObject::GetPresentation ( ) const

inline

Returns a tessellated annotation if specified.

HasPlane()

Standard_Boolean XCAFNoteObjects_NoteObject::HasPlane ( ) const

inline

Returns True if plane is specified.

HasPoint()

Standard_Boolean XCAFNoteObjects_NoteObject::HasPoint ( ) const

inline

Returns True if the attachment point on the annotated object is specified.

HasPointText()

Standard_Boolean XCAFNoteObjects_NoteObject::HasPointText ( ) const

inline

Returns True if the text position is specified.

Reset()

void XCAFNoteObjects_NoteObject::Reset

(

)

Resets data to the state after calling the default constructor.

SetPlane()

void XCAFNoteObjects_NoteObject::SetPlane

(

const gp_Ax2 &

thePlane

)

Sets a right-handed coordinate system of the plane.

SetPoint()

void XCAFNoteObjects_NoteObject::SetPoint

(

const gp_Pnt &

thePnt

)

Sets the anchor point on the annotated object.

SetPointText()

void XCAFNoteObjects_NoteObject::SetPointText

(

const gp_Pnt &

thePnt

)

Sets the text position.

SetPresentation()

void XCAFNoteObjects_NoteObject::SetPresentation

(

const TopoDS_Shape &

thePresentation

)

Sets a tessellated annotation.

---

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

• XCAFNoteObjects_NoteObject.hxx