#include <Cosmetic.h>

Public Member Functions

CosmeticVertexclone (void) const
 
CosmeticVertexcopy (void) const
 
 CosmeticVertex ()
 
 CosmeticVertex (Base::Vector3d loc)
 
 CosmeticVertex (const CosmeticVertex *cv)
 
void dump (const char *title)
 
virtual unsigned int getMemSize (void) const
 This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...
 
virtual PyObjectgetPyObject (void)
 This method returns the Python wrapper for a C++ object. More...
 
boost::uuids::uuid getTag () const
 
virtual std::string getTagAsString (void) const
 
void move (Base::Vector3d newPos)
 
void moveRelative (Base::Vector3d movement)
 
virtual void Restore (Base::XMLReader &)
 This method is used to restore properties from an XML document. More...
 
virtual void Save (Base::Writer &) const
 This method is used to save properties to an XML document. More...
 
Base::Vector3d scaled (double factor)
 
std::string toString (void) const
 
virtual ~CosmeticVertex ()=default
 
- Public Member Functions inherited from Base::Persistence
void dumpToStream (std::ostream &stream, int compression)
 
virtual Base::Type getTypeId (void) const
 
virtual void RestoreDocFile (Reader &)
 This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More...
 
void restoreFromStream (std::istream &stream)
 
virtual void SaveDocFile (Writer &) const
 This method is used to save large amounts of data to a binary file. More...
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction. More...
 
bool isDerivedFrom (const Type type) const
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 
- Public Member Functions inherited from TechDraw::Vertex
boost::uuids::uuid getTag () const
 
bool isEqual (Vertex *v, double tol)
 
void point (Base::Vector3d v)
 
Base::Vector3d point (void) const
 
 Vertex ()
 
 Vertex (Base::Vector3d v)
 
 Vertex (const Vertex *v)
 
 Vertex (double x, double y)
 
double x ()
 
double y ()
 
virtual ~Vertex ()
 

Static Public Member Functions

static bool restoreCosmetic (void)
 
- Static Public Member Functions inherited from Base::Persistence
static void * create (void)
 
static std::string encodeAttribute (const std::string &)
 Encodes an attribute upon saving. More...
 
static Base::Type getClassTypeId (void)
 
static void init (void)
 
- Static Public Member Functions inherited from Base::BaseClass
static void * create (void)
 
static Type getClassTypeId (void)
 
static void init (void)
 

Public Attributes

App::Color color
 
int linkGeom
 
Base::Vector3d permaPoint
 
double size
 
int style
 
bool visible
 
- Public Attributes inherited from TechDraw::Vertex
bool cosmetic
 
int cosmeticLink
 
std::string cosmeticTag
 
ExtractionType extractType
 
bool hlrVisible
 
bool isCenter
 
TopoDS_Vertex occVertex
 
Base::Vector3d pnt
 
int ref3D
 
bool reference
 

Protected Member Functions

void assignTag (const TechDraw::CosmeticVertex *cv)
 
void createNewTag ()
 
- Protected Member Functions inherited from TechDraw::Vertex
void assignTag (const TechDraw::Vertex *v)
 
void createNewTag ()
 

Protected Attributes

Py::Object PythonObject
 
boost::uuids::uuid tag
 
- Protected Attributes inherited from TechDraw::Vertex
boost::uuids::uuid tag
 

Additional Inherited Members

- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
 

Constructor & Destructor Documentation

◆ CosmeticVertex() [1/3]

◆ CosmeticVertex() [2/3]

CosmeticVertex::CosmeticVertex ( const CosmeticVertex cv)

◆ CosmeticVertex() [3/3]

◆ ~CosmeticVertex()

virtual TechDraw::CosmeticVertex::~CosmeticVertex ( )
virtualdefault

Member Function Documentation

◆ assignTag()

void CosmeticVertex::assignTag ( const TechDraw::CosmeticVertex cv)
protected

◆ clone()

◆ copy()

CosmeticVertex * CosmeticVertex::copy ( void  ) const

◆ createNewTag()

void CosmeticVertex::createNewTag ( )
protected

References tag.

Referenced by CosmeticVertex().

◆ dump()

void CosmeticVertex::dump ( const char *  title)
virtual

◆ getMemSize()

unsigned int CosmeticVertex::getMemSize ( void  ) const
virtual

This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB?

Implements Base::Persistence.

◆ getPyObject()

PyObject * CosmeticVertex::getPyObject ( void  )
virtual

This method returns the Python wrapper for a C++ object.

It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.

The default implementation returns 'None'.

Reimplemented from Base::BaseClass.

References PythonObject.

Referenced by TechDraw::DrawViewPartPy::getCosmeticVertex(), and TechDraw::DrawViewPartPy::getCosmeticVertexBySelection().

◆ getTag()

boost::uuids::uuid CosmeticVertex::getTag ( void  ) const

References tag.

Referenced by getTagAsString().

◆ getTagAsString()

◆ move()

◆ moveRelative()

void CosmeticVertex::moveRelative ( Base::Vector3d  movement)

References permaPoint.

◆ Restore()

void CosmeticVertex::Restore ( Base::XMLReader )
virtual

This method is used to restore properties from an XML document.

It uses the XMLReader class, which bases on SAX, to read the in Save() written information. Again the Vector as an example:

void PropertyVector::Restore(Base::XMLReader &reader)
{
// read my Element
reader.readElement("PropertyVector");
// get the value of my Attribute
_cVec.x = reader.getAttributeAsFloat("valueX");
_cVec.y = reader.getAttributeAsFloat("valueY");
_cVec.z = reader.getAttributeAsFloat("valueZ");
}
The XML reader class This is an important helper class for the store and retrieval system of objects ...
Definition: Reader.h:118
void readElement(const char *ElementName=0)
read until a start element is found (<name>) or start-end element (<name/>) (with special name if giv...
Definition: Reader.cpp:240
double getAttributeAsFloat(const char *AttrName) const
return the named attribute as a double floating point (does type checking)
Definition: Reader.cpp:158

Implements Base::Persistence.

References Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsFloat(), Base::XMLReader::getAttributeAsInteger(), linkGeom, permaPoint, Base::XMLReader::readElement(), TechDraw::Vertex::Restore(), restoreCosmetic(), style, tag, visible, Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

Referenced by TechDraw::PropertyCosmeticVertexList::Restore().

◆ restoreCosmetic()

◆ Save()

void CosmeticVertex::Save ( Base::Writer ) const
virtual

This method is used to save properties to an XML document.

A good example you'll find in PropertyStandard.cpp, e.g. the vector:

void PropertyVector::Save (Writer &writer) const
{
writer << writer.ind() << "<PropertyVector valueX=\"" << _cVec.x <<
"\" valueY=\"" << _cVec.y <<
"\" valueZ=\"" << _cVec.z <<"\"/>" << endl;
}

The writer.ind() expression writes the indentation, just for pretty printing of the XML. As you see, the writing of the XML document is not done with a DOM implementation because of performance reasons. Therefore the programmer has to take care that a valid XML document is written. This means closing tags and writing UTF-8.

See also
Base::Writer

Implements Base::Persistence.

References getTagAsString(), Base::Writer::ind(), linkGeom, permaPoint, TechDraw::Vertex::Save(), Base::Writer::Stream(), style, visible, Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

◆ scaled()

Base::Vector3d CosmeticVertex::scaled ( double  factor)

◆ toString()

Member Data Documentation

◆ color

◆ linkGeom

int TechDraw::CosmeticVertex::linkGeom

◆ permaPoint

◆ PythonObject

Py::Object TechDraw::CosmeticVertex::PythonObject
protected

Referenced by getPyObject().

◆ size

◆ style

◆ tag

◆ visible


The documentation for this class was generated from the following files:
  • Sources/FreeCAD/src/Mod/TechDraw/App/Cosmetic.h
  • Sources/FreeCAD/src/Mod/TechDraw/App/Cosmetic.cpp