#include <Geometry.h>

Public Member Functions
virtual Geometry *	copy (void) const
	returns a copy of this object having a new randomly generated tag. More...

	GeomLine ()

	GeomLine (const Base::Vector3d &Pos, const Base::Vector3d &Dir)

	GeomLine (const Handle(Geom_Line)&)

Base::Vector3d	getDir (void) const

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...

Base::Vector3d	getPos (void) const

virtual PyObject *	getPyObject (void)
	This method returns the Python wrapper for a C++ object. More...

const	Handle (Geom_Geometry) &handle() const

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...

void	setHandle (const Handle(Geom_Line)&)

void	setLine (const Base::Vector3d &Pos, const Base::Vector3d &Dir)

virtual	~GeomLine ()

Public Member Functions inherited from Part::GeomCurve
bool	closestParameter (const Base::Vector3d &point, double &u) const

bool	closestParameterToBasisCurve (const Base::Vector3d &point, double &u) const

double	curvatureAt (double u) const

Base::Vector3d	firstDerivativeAtParameter (double u) const

	GeomCurve ()

double	getFirstParameter () const

double	getLastParameter () const

bool	intersect (GeomCurve *c, std::vector< std::pair< Base::Vector3d, Base::Vector3d >> &points, double tol=Precision::Confusion()) const

double	length (double u, double v) const

bool	normalAt (double u, Base::Vector3d &dir) const

Base::Vector3d	pointAtParameter (double u) const

void	reverse (void)

Base::Vector3d	secondDerivativeAtParameter (double u) const

bool	tangent (double u, Base::Vector3d &dir) const

bool	tangent (double u, gp_Dir &) const

GeomBSplineCurve *	toBSpline (double first, double last) const
	toBSpline Converts the curve to a B-spline More...

virtual GeomBSplineCurve *	toNurbs (double first, double last) const

TopoDS_Shape	toShape () const

virtual	~GeomCurve ()

Public Member Functions inherited from Part::Geometry
Geometry *	clone (void) const
	returns a cloned object. More...

void	deleteExtension (Base::Type type)

void	deleteExtension (std::string name)

const std::weak_ptr< GeometryExtension >	getExtension (Base::Type type) const

const std::weak_ptr< GeometryExtension >	getExtension (std::string name) const

const std::vector< std::weak_ptr< GeometryExtension > >	getExtensions () const

boost::uuids::uuid	getTag () const
	returns the tag of the geometry object More...

bool	hasExtension (Base::Type type) const

bool	hasExtension (std::string name) const

void	setExtension (std::unique_ptr< GeometryExtension > &&geo)

virtual	~Geometry ()

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...

Additional Inherited Members
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 inherited from Part::Geometry
bool	Construction
	construction geometry (means no impact on a later built topo) Note: In the Sketcher and only for the specific case of a point, it has a special meaning: a construction point has fixed coordinates for the solver (it has fixed parameters) More...

Protected Member Functions inherited from Part::Geometry
void	assignTag (const Part::Geometry *)
	copies the tag from the geometry passed as a parameter to this object More...

void	createNewTag ()
	create a new tag for the geometry object More...

	Geometry ()

Static Protected Member Functions inherited from Part::GeomCurve
static bool	intersect (const Handle(Geom_Curve) c, const Handle(Geom_Curve) c2, std::vector< std::pair< Base::Vector3d, Base::Vector3d >> &points, double tol=Precision::Confusion())

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

Protected Attributes inherited from Part::Geometry
std::vector< std::shared_ptr< GeometryExtension > >	extensions

boost::uuids::uuid	tag

Constructor & Destructor Documentation

◆ GeomLine() [1/3]

GeomLine::GeomLine ( )

Referenced by copy().

◆ GeomLine() [2/3]

GeomLine::GeomLine ( const Handle(Geom_Line)& l )

References setHandle().

◆ GeomLine() [3/3]

GeomLine::GeomLine	(	const Base::Vector3d &	Pos,
		const Base::Vector3d &	Dir
	)

References Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

◆ ~GeomLine()

GeomLine::~GeomLine ( )

virtual

Member Function Documentation

◆ copy()

Geometry * GeomLine::copy ( void ) const

virtual

returns a copy of this object having a new randomly generated tag.

If you also want to copy the tag, you may use clone() instead. For creation of geometry with other handles, with or without the same tag, you may use the constructors and the sethandle functions. The tag of a geometry can be copied to another geometry using the assignTag function.

Implements Part::Geometry.

References Part::Geometry::Construction, and GeomLine().

◆ getDir()

Base::Vector3d GeomLine::getDir ( void ) const

Referenced by Save().

◆ getMemSize()

unsigned int GeomLine::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?

Reimplemented from Part::Geometry.

◆ getPos()

Base::Vector3d GeomLine::getPos ( void ) const

Referenced by Save().

◆ getPyObject()

PyObject * GeomLine::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.

◆ Handle()

const Part::GeomLine::Handle ( Geom_Geometry ) const &

virtual

Implements Part::Geometry.

◆ Restore()

void GeomLine::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");
}

Reimplemented from Part::Geometry.

References Base::XMLReader::getAttributeAsFloat(), Base::XMLReader::readElement(), Part::Geometry::Restore(), and setLine().

◆ Save()

void GeomLine::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

Reimplemented from Part::Geometry.

References getDir(), getPos(), Base::Writer::ind(), Part::Geometry::Save(), Base::Writer::Stream(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

◆ setHandle()

void Part::GeomLine::setHandle ( const Handle(Geom_Line)& )

Referenced by GeomLine().

◆ setLine()

void GeomLine::setLine	(	const Base::Vector3d &	Pos,
		const Base::Vector3d &	Dir
	)

References Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

Referenced by Restore().

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

src/Mod/Part/App/Geometry.h
src/Mod/Part/App/Geometry.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ GeomLine() [1/3]

◆ GeomLine() [2/3]

◆ GeomLine() [3/3]

◆ ~GeomLine()

Member Function Documentation

◆ copy()

◆ getDir()

◆ getMemSize()

◆ getPos()

◆ getPyObject()

◆ Handle()

◆ Restore()

◆ Save()

◆ setHandle()

◆ setLine()