#include <Cosmetic.h>

Public Types

enum  CLMODE { VERTICAL , HORIZONTAL , ALIGNED }
 
enum  CLTYPE { FACE , EDGE , VERTEX }
 

Public Member Functions

 CenterLine ()
 
 CenterLine (Base::Vector3d p1, Base::Vector3d p2)
 
 CenterLine (Base::Vector3d p1, Base::Vector3d p2, int m, double h, double v, double r, double x)
 
 CenterLine (CenterLine *cl)
 
 CenterLine (TechDraw::BaseGeom *bg)
 
CenterLineclone (void) const
 
CenterLinecopy (void) const
 
void dump (const char *title)
 
double getExtend (void)
 
bool getFlip (void)
 
double getHShift (void)
 
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...
 
double getRotate (void)
 
boost::uuids::uuid getTag () const
 
virtual std::string getTagAsString (void) const
 
double getVShift (void)
 
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...
 
TechDraw::BaseGeomscaledGeometry (TechDraw::DrawViewPart *partFeat)
 
void setExtend (double e)
 
void setFlip (bool f)
 
void setRotate (double r)
 
void setShifts (double h, double v)
 
std::string toString (void) const
 
virtual ~CenterLine ()
 
- 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...
 

Static Public Member Functions

static std::pair< Base::Vector3d, Base::Vector3dcalcEndPoints (TechDraw::DrawViewPart *partFeat, std::vector< std::string > faceNames, int mode, double ext, double m_hShift, double m_vShift, double rotate)
 
static std::pair< Base::Vector3d, Base::Vector3dcalcEndPoints2Lines (TechDraw::DrawViewPart *partFeat, std::vector< std::string > faceNames, int vert, double ext, double m_hShift, double m_vShift, double rotate, bool flip)
 
static std::pair< Base::Vector3d, Base::Vector3dcalcEndPoints2Points (TechDraw::DrawViewPart *partFeat, std::vector< std::string > faceNames, int vert, double ext, double m_hShift, double m_vShift, double rotate, bool flip)
 
static CenterLineCenterLineBuilder (TechDraw::DrawViewPart *partFeat, std::vector< std::string > subs, int mode=0, bool flip=false)
 
- 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

std::vector< std::string > m_edges
 
Base::Vector3d m_end
 
double m_extendBy
 
std::vector< std::string > m_faces
 
bool m_flip2Line
 
LineFormat m_format
 
TechDraw::BaseGeomm_geometry
 
double m_hShift
 
int m_mode
 
double m_rotate
 
Base::Vector3d m_start
 
int m_type
 
std::vector< std::string > m_verts
 
double m_vShift
 

Protected Member Functions

void assignTag (const TechDraw::CenterLine *cl)
 
void createNewTag ()
 
void initialize ()
 

Protected Attributes

Py::Object PythonObject
 
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)
 

Member Enumeration Documentation

◆ CLMODE

Enumerator
VERTICAL 
HORIZONTAL 
ALIGNED 

◆ CLTYPE

Enumerator
FACE 
EDGE 
VERTEX 

Constructor & Destructor Documentation

◆ CenterLine() [1/5]

CenterLine::CenterLine ( void  )

Referenced by copy().

◆ CenterLine() [2/5]

◆ CenterLine() [3/5]

◆ CenterLine() [4/5]

◆ CenterLine() [5/5]

◆ ~CenterLine()

CenterLine::~CenterLine ( )
virtual

Member Function Documentation

◆ assignTag()

void CenterLine::assignTag ( const TechDraw::CenterLine cl)
protected

◆ calcEndPoints()

◆ calcEndPoints2Lines()

◆ calcEndPoints2Points()

◆ CenterLineBuilder()

◆ clone()

◆ copy()

◆ createNewTag()

void CenterLine::createNewTag ( )
protected

References tag.

Referenced by initialize().

◆ dump()

void CenterLine::dump ( const char *  title)

◆ getExtend()

double CenterLine::getExtend ( void  )

◆ getFlip()

bool CenterLine::getFlip ( void  )

References m_flip2Line.

Referenced by TechDraw::CenterLinePy::getFlip().

◆ getHShift()

double CenterLine::getHShift ( void  )

◆ getMemSize()

unsigned int CenterLine::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 * CenterLine::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::getCenterLine(), and TechDraw::DrawViewPartPy::getCenterLineBySelection().

◆ getRotate()

double CenterLine::getRotate ( void  )

References m_rotate.

Referenced by TechDraw::CenterLinePy::getRotation().

◆ getTag()

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

References tag.

Referenced by getTagAsString().

◆ getTagAsString()

std::string CenterLine::getTagAsString ( void  ) const
virtual

◆ getVShift()

double CenterLine::getVShift ( void  )

◆ initialize()

◆ Restore()

void CenterLine::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::Console(), TechDraw::GeometryUtils::edgeFromCircle(), TechDraw::GeometryUtils::edgeFromCircleArc(), TechDraw::GeometryUtils::edgeFromGeneric(), App::Color::fromHexString(), Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsFloat(), Base::XMLReader::getAttributeAsInteger(), TechDraw::LineFormat::m_color, m_edges, m_end, m_extendBy, m_faces, m_flip2Line, m_format, m_geometry, m_hShift, m_mode, m_rotate, m_start, TechDraw::LineFormat::m_style, m_type, m_verts, TechDraw::LineFormat::m_visible, m_vShift, TechDraw::LineFormat::m_weight, TechDraw::BaseGeom::occEdge, Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), TechDraw::Circle::Restore(), TechDraw::AOC::Restore(), TechDraw::Generic::Restore(), TechDraw::CosmeticVertex::restoreCosmetic(), Base::ConsoleSingleton::Warning(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

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

◆ Save()

void CenterLine::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 App::Color::asHexString(), Base::Console(), Base::Writer::decInd(), Base::ConsoleSingleton::Error(), TechDraw::BaseGeom::geomType, Base::Writer::incInd(), Base::Writer::ind(), TechDraw::LineFormat::m_color, m_edges, m_end, m_extendBy, m_faces, m_flip2Line, m_format, m_geometry, m_hShift, m_mode, m_rotate, m_start, TechDraw::LineFormat::m_style, m_type, m_verts, TechDraw::LineFormat::m_visible, m_vShift, TechDraw::LineFormat::m_weight, Base::ConsoleSingleton::Message(), TechDraw::Circle::Save(), TechDraw::AOC::Save(), TechDraw::Generic::Save(), Base::Writer::Stream(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

◆ scaledGeometry()

◆ setExtend()

void CenterLine::setExtend ( double  e)

◆ setFlip()

void CenterLine::setFlip ( bool  f)

References m_flip2Line.

Referenced by TechDraw::CenterLinePy::setFlip().

◆ setRotate()

void CenterLine::setRotate ( double  r)

◆ setShifts()

void CenterLine::setShifts ( double  h,
double  v 
)

◆ toString()

Member Data Documentation

◆ m_edges

std::vector<std::string> TechDraw::CenterLine::m_edges

◆ m_end

Base::Vector3d TechDraw::CenterLine::m_end

Referenced by CenterLine(), copy(), Restore(), Save(), and toString().

◆ m_extendBy

◆ m_faces

std::vector<std::string> TechDraw::CenterLine::m_faces

◆ m_flip2Line

◆ m_format

◆ m_geometry

TechDraw::BaseGeom* TechDraw::CenterLine::m_geometry

◆ m_hShift

◆ m_mode

◆ m_rotate

◆ m_start

Base::Vector3d TechDraw::CenterLine::m_start

Referenced by CenterLine(), copy(), Restore(), Save(), and toString().

◆ m_type

◆ m_verts

std::vector<std::string> TechDraw::CenterLine::m_verts

◆ m_vShift

◆ PythonObject

Py::Object TechDraw::CenterLine::PythonObject
protected

Referenced by getPyObject().

◆ tag


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