C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2
MaAnnotationItem Class Reference

Annotation object. More...

#include <conv_annotation_item.h>

+ Inheritance diagram for MaAnnotationItem:
+ Collaboration diagram for MaAnnotationItem:

Public Member Functions

 MaAnnotationItem (const MbPlacement3D &loc)
 Constructor by annotation plane.
 
virtual ~MaAnnotationItem ()
 Destructor.
 
virtual Mae_AnnotationType IsA () const
 Get the object type.
 
virtual Mae_AnnotationType Type () const
 Get the group type of the object.
 
virtual bool VisualItemsEmpty () const
 Whether the visual representation is empty.
 
bool GeometryEmpty () const
 Whether there are no geometric items.
 
bool TextEmpty () const
 Whether there are no text items.
 
void AddGeometricAnnotationElement (const MbItem &)
 Add the geometric visual annotation element of the kernel.
 
void AddAnnotationGeometryTo (std::vector< SPtr< MbItem > > &addTo) const
 Add own geometric visual annotation elements to container.
 
size_t TextItemsCount () const
 Count of text items.
 
SPtr< MaTextItemTextItem (size_t) const
 Get specified text item.
 
template<typename In >
void SetAnnotationGeometry (In first, In last)
 Set the annotation objects of the kernel.
 
template<typename Out >
void GetAnnotationGeometry (Out dest) const
 Get the annotation objects of the kernel. Method push_back should be defined for the receiver.
 
template<typename In >
void SetAnnotationText (In first, In last)
 Get the text annotation object.
 
template<typename Out >
void GetAnnotationText (Out dest) const
 Get text annotation objects. Method push_back should be defined for the receiver.
 
void AddPlaneItems (const std::vector< SPtr< MbPlaneItem > > &)
 Add planar objects to geometric objects using current location.
 
void SetLocation (const MbPlacement3D &loc)
 Specify LCS.
 
MbPlacement3D GetLocation () const
 Get LCS.
 
void SetC3dName (const c3d::string_t &nm)
 Specify name.
 
c3d::string_t GetC3dName () const
 Specify name.
 
void SetVisibility (bool v)
 Set visibility.
 
bool IsVisible () const
 Is object vivible.
 
virtual SPtr< MaAnnotationItemShallowDuplicateTransform (const MbMatrix3D &, MbRegDuplicate *partDuplicateRegistry=nullptr)
 Create a replica then transform it.
 
void InitExceplLocation (const MaAnnotationItem &init)
 Init all fields except for location according to the specified item.
 
- Public Member Functions inherited from MbRefItem
virtual MbeRefType RefType () const
 Registration type (for copying, duplication).
 
refcount_t GetUseCount () const
 Get count of references (get count of owners of an object).
 
refcount_t AddRef () const
 Increase count of references by one.
 
refcount_t DecRef () const
 Decrease count of references by one.
 
refcount_t Release () const
 Decrease count of references by one and if count of references became zero, then remove itself.
 

Protected Member Functions

virtual void DuplicateTransformDeometry (const MbMatrix3D &)
 Replace all geometric items by transformed copies.
 
- Protected Member Functions inherited from MbRefItem
 MbRefItem ()
 Constructor without parameters.
 

Protected Attributes

MbPlacement3D location
 Local coordinate system (LCS) the annotation objects are located in XY plane of.
 
std::vector< const MbItem * > annotationGeometry
 Geometric objects of annotation.
 
std::vector< SPtr< const MaTextItem > > annotationText
 Text annotation objects.
 
c3d::string_t name
 Name.
 
bool visible
 If object is vivible.
 

Detailed Description

Annotation object.


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