1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-16 10:08:36 +03:00
occt/src/XCAFNoteObjects/XCAFNoteObjects_NoteObject.hxx
snn 8c7fab9b4d 0029621: Application Framework - Impossible to attach existing tessellation to XCAFDoc_Note
- XCAFNoteObjects_NoteObject transfer object for note's auxiliary data was added. It contains the following fields:
  text and attachment positions, note plane and tesselated presentation
- GetObject/SetObject methods were added to XCAFDoc_Note attribute. The following sub-labels were added to handle transfer object:
  1 - text position
  2 - note plane
  3 - attachment point
  4 - tesselated presentation
- documentation updated

Off-topic: procedure genproj now gives meaningful error message if new package is added but not listed in UDLIST
2018-05-25 21:54:54 +03:00

87 lines
2.8 KiB
C++

// Copyright (c) 2018 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
#ifndef _XCAFNoteObjects_NoteObject_HeaderFile
#define _XCAFNoteObjects_NoteObject_HeaderFile
#include <gp_Ax2.hxx>
#include <gp_Pnt.hxx>
#include <Standard.hxx>
#include <Standard_Transient.hxx>
#include <Standard_Type.hxx>
#include <TopoDS_Shape.hxx>
//! object to store note auxiliary data
class XCAFNoteObjects_NoteObject : public Standard_Transient
{
DEFINE_STANDARD_RTTIEXT(XCAFNoteObjects_NoteObject, Standard_Transient)
public:
//! Empty object
Standard_EXPORT XCAFNoteObjects_NoteObject();
//! Copy constructor.
Standard_EXPORT XCAFNoteObjects_NoteObject (const Handle(XCAFNoteObjects_NoteObject)& theObj);
//! Returns True if plane is specified
Standard_Boolean HasPlane() const { return myHasPlane; }
//! Returns a right-handed coordinate system of the plane
const gp_Ax2& GetPlane() const { return myPlane; }
//! Sets a right-handed coordinate system of the plane
Standard_EXPORT void SetPlane (const gp_Ax2& thePlane);
//! Returns True if the attachment point on the annotated object is specified
Standard_Boolean HasPoint() const { return myHasPnt; }
//! Returns the attachment point on the annotated object
const gp_Pnt& GetPoint() const { return myPnt; }
//! Sets the anchor point on the annotated object
Standard_EXPORT void SetPoint (const gp_Pnt& thePnt);
//! Returns True if the text position is specified
Standard_Boolean HasPointText() const { return myHasPntTxt; }
//! Returns the text position
const gp_Pnt& GetPointText() const { return myPntTxt; }
//! Sets the text position
Standard_EXPORT void SetPointText (const gp_Pnt& thePnt);
//! Returns a tesselated annotation if specified
const TopoDS_Shape& GetPresentation() const { return myPresentation; }
//! Sets a tesselated annotation
Standard_EXPORT void SetPresentation (const TopoDS_Shape& thePresentation);
//! Resets data to the state after calling the default constructor
Standard_EXPORT void Reset();
private:
gp_Ax2 myPlane;
gp_Pnt myPnt;
gp_Pnt myPntTxt;
TopoDS_Shape myPresentation;
Standard_Boolean myHasPlane;
Standard_Boolean myHasPnt;
Standard_Boolean myHasPntTxt;
};
DEFINE_STANDARD_HANDLE(XCAFNoteObjects_NoteObject, Standard_Transient)
#endif // _XCAFNoteObjects_NoteObject_HeaderFile