#include <SolverGeometryExtension.h>

Classes
class	Arc

class	ArcOfEllipse

class	ArcOfHyperbola

class	ArcOfParabola

class	BSpline

class	Circle

class	EdgeParameterStatus

class	Ellipse

class	Line

class	Point

class	PointParameterStatus

Public Types
enum	ParameterStatus { Dependent = 0 , Independent = 1 , NumParameterStatus }

enum	SolverStatus { FullyConstraint = 0 , NotFullyConstraint = 1 , NumSolverStatus }

Public Member Functions
virtual std::unique_ptr< Part::GeometryExtension >	copy (void) const override

Arc &	getArc ()

ArcOfEllipse &	getArcOfEllipse ()

ArcOfHyperbola &	getArcOfHyperbola ()

ArcOfParabola &	getArcOfParabola ()

BSpline &	getBSpline ()

Circle &	getCircle ()

ParameterStatus	getEdge () const

EdgeParameterStatus	getEdgeParameters ()

Ellipse &	getEllipse ()

ParameterStatus	getEnd () const

PointParameterStatus	getEndPoint () const

SolverStatus	getGeometry () const

Line &	getLine ()

ParameterStatus	getMid () const

PointParameterStatus	getMidPoint () const

Point &	getPoint ()

PointParameterStatus	getPoint (Sketcher::PointPos pos) const

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

ParameterStatus	getStart () const

PointParameterStatus	getStartPoint () const

void	init (ParameterStatus status)

virtual void	notifyAttachment (Part::Geometry *geo) override

void	setEdge (int paramindex, ParameterStatus status)

void	setEdge (ParameterStatus status)

void	setEnd (ParameterStatus xstatus, ParameterStatus ystatus)

void	setEndx (ParameterStatus xstatus)

void	setEndy (ParameterStatus ystatus)

void	setMid (ParameterStatus xstatus, ParameterStatus ystatus)

void	setMidx (ParameterStatus xstatus)

void	setMidy (ParameterStatus ystatus)

void	setStart (ParameterStatus xstatus, ParameterStatus ystatus)

void	setStartx (ParameterStatus xstatus)

void	setStarty (ParameterStatus ystatus)

	SolverGeometryExtension ()

virtual	~SolverGeometryExtension () override=default

Public Member Functions inherited from Part::GeometryExtension
virtual std::unique_ptr< GeometryExtension >	copy (void) const =0

PyObject *	copyPyObject () const

const std::string &	getName () const

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

virtual void	notifyAttachment (Part::Geometry *)

void	setName (const std::string &str)

virtual	~GeometryExtension ()=default

Public Member Functions inherited from Base::BaseClass
	BaseClass ()
	Construction. More...

	BaseClass (const BaseClass &)=default

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

virtual Type	getTypeId () const

bool	isDerivedFrom (const Type type) const

BaseClass &	operator= (const BaseClass &)=default

virtual void	setPyObject (PyObject *)

virtual	~BaseClass ()
	Destruction. More...

Protected Member Functions
virtual void	copyAttributes (Part::GeometryExtension *cpy) const override

Protected Member Functions inherited from Part::GeometryExtension
virtual void	copyAttributes (Part::GeometryExtension *cpy) const

	GeometryExtension ()

	GeometryExtension (const GeometryExtension &obj)=default

GeometryExtension &	operator= (const GeometryExtension &obj)=default

Additional Inherited Members
Static Public Member Functions inherited from Base::BaseClass
static void *	create ()

static Type	getClassTypeId ()

static void	init ()

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

◆ ParameterStatus

enum Sketcher::SolverGeometryExtension::ParameterStatus

Enumerator
Dependent
Independent
NumParameterStatus

◆ SolverStatus

enum Sketcher::SolverGeometryExtension::SolverStatus

Enumerator
FullyConstraint
NotFullyConstraint
NumSolverStatus

Constructor & Destructor Documentation

◆ SolverGeometryExtension()

SolverGeometryExtension::SolverGeometryExtension ( )

◆ ~SolverGeometryExtension()

virtual Sketcher::SolverGeometryExtension::~SolverGeometryExtension ( )

overridevirtualdefault

Member Function Documentation

◆ copy()

std::unique_ptr< Part::GeometryExtension > SolverGeometryExtension::copy ( void ) const

overridevirtual

Implements Part::GeometryExtension.

References copyAttributes(), and draftfunctions.move::move().

◆ copyAttributes()

void SolverGeometryExtension::copyAttributes ( Part::GeometryExtension * cpy ) const

overrideprotectedvirtual

Reimplemented from Part::GeometryExtension.

References Part::GeometryExtension::copyAttributes().

Referenced by copy().

◆ getArc()

SolverGeometryExtension::Arc & SolverGeometryExtension::getArc ( )

References Base::Persistence::getClassTypeId().

◆ getArcOfEllipse()

SolverGeometryExtension::ArcOfEllipse & SolverGeometryExtension::getArcOfEllipse ( )

References Base::Persistence::getClassTypeId().

◆ getArcOfHyperbola()

SolverGeometryExtension::ArcOfHyperbola & SolverGeometryExtension::getArcOfHyperbola ( )

References Base::Persistence::getClassTypeId().

◆ getArcOfParabola()

SolverGeometryExtension::ArcOfParabola & SolverGeometryExtension::getArcOfParabola ( )

References Base::Persistence::getClassTypeId().

◆ getBSpline()

SolverGeometryExtension::BSpline & SolverGeometryExtension::getBSpline ( )

References Base::Persistence::getClassTypeId().

◆ getCircle()

SolverGeometryExtension::Circle & SolverGeometryExtension::getCircle ( )

References Base::Persistence::getClassTypeId().

◆ getEdge()

ParameterStatus Sketcher::SolverGeometryExtension::getEdge ( ) const

◆ getEdgeParameters()

EdgeParameterStatus Sketcher::SolverGeometryExtension::getEdgeParameters ( )

◆ getEllipse()

SolverGeometryExtension::Ellipse & SolverGeometryExtension::getEllipse ( )

References Base::Persistence::getClassTypeId().

◆ getEnd()

ParameterStatus Sketcher::SolverGeometryExtension::getEnd ( ) const

◆ getEndPoint()

PointParameterStatus Sketcher::SolverGeometryExtension::getEndPoint ( ) const

Referenced by getPoint().

◆ getGeometry()

SolverStatus Sketcher::SolverGeometryExtension::getGeometry ( ) const

◆ getLine()

SolverGeometryExtension::Line & SolverGeometryExtension::getLine ( )

References Base::Persistence::getClassTypeId().

◆ getMid()

ParameterStatus Sketcher::SolverGeometryExtension::getMid ( ) const

◆ getMidPoint()

PointParameterStatus Sketcher::SolverGeometryExtension::getMidPoint ( ) const

Referenced by getPoint().

◆ getPoint() [1/2]

SolverGeometryExtension::Point & SolverGeometryExtension::getPoint ( void )

References Base::Persistence::getClassTypeId().

Referenced by ArchStructure.CommandStructuralSystem::Activated(), PathScripts.PathOpGui.TaskPanelBaseLocationPage::addLocation(), PathScripts.PathDressupTagGui.PathDressupTagTaskPanel::addNewTag(), PathScripts.PathOpGui.TaskPanelBaseLocationPage::editLocation(), PathScripts.PathDressupTagGui.PathDressupTagTaskPanel::editTag(), draftguitools.gui_arcs.Arc_3Points::getPoint(), ArchCurtainWall.CommandArchCurtainWall::getPoint(), ArchTruss.CommandArchTruss::getPoint(), PathScripts.PathDressupTagGui.PathDressupTagTaskPanel::modifyStandardButtons(), and PathScripts.PathOpGui.TaskPanelBaseLocationPage::modifyStandardButtons().

◆ getPoint() [2/2]

SolverGeometryExtension::PointParameterStatus SolverGeometryExtension::getPoint ( Sketcher::PointPos pos ) const

References Sketcher::end, getEndPoint(), getMidPoint(), getStartPoint(), Sketcher::mid, and Sketcher::start.

Referenced by ArchStructure.CommandStructuralSystem::Activated(), PathScripts.PathOpGui.TaskPanelBaseLocationPage::addLocation(), PathScripts.PathDressupTagGui.PathDressupTagTaskPanel::addNewTag(), PathScripts.PathOpGui.TaskPanelBaseLocationPage::editLocation(), PathScripts.PathDressupTagGui.PathDressupTagTaskPanel::editTag(), draftguitools.gui_arcs.Arc_3Points::getPoint(), ArchCurtainWall.CommandArchCurtainWall::getPoint(), ArchTruss.CommandArchTruss::getPoint(), PathScripts.PathDressupTagGui.PathDressupTagTaskPanel::modifyStandardButtons(), and PathScripts.PathOpGui.TaskPanelBaseLocationPage::modifyStandardButtons().

◆ getPyObject()

PyObject * SolverGeometryExtension::getPyObject ( void )

overridevirtual

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

Implements Part::GeometryExtension.

◆ getStart()

ParameterStatus Sketcher::SolverGeometryExtension::getStart ( ) const

◆ getStartPoint()

PointParameterStatus Sketcher::SolverGeometryExtension::getStartPoint ( ) const

Referenced by getPoint().

◆ init()

void Sketcher::SolverGeometryExtension::init ( ParameterStatus status )

Referenced by DocumentObject.DocumentObject::onChanged().

◆ notifyAttachment()

void SolverGeometryExtension::notifyAttachment ( Part::Geometry * geo )

overridevirtual

Reimplemented from Part::GeometryExtension.

References Base::Persistence::getClassTypeId(), and Base::Persistence::getTypeId().

◆ setEdge() [1/2]

void Sketcher::SolverGeometryExtension::setEdge	(	int	paramindex,
		ParameterStatus	status
	)

◆ setEdge() [2/2]

void Sketcher::SolverGeometryExtension::setEdge ( ParameterStatus status )

◆ setEnd()

void Sketcher::SolverGeometryExtension::setEnd	(	ParameterStatus	xstatus,
		ParameterStatus	ystatus
	)

◆ setEndx()

void Sketcher::SolverGeometryExtension::setEndx ( ParameterStatus xstatus )

◆ setEndy()

void Sketcher::SolverGeometryExtension::setEndy ( ParameterStatus ystatus )

◆ setMid()

void Sketcher::SolverGeometryExtension::setMid	(	ParameterStatus	xstatus,
		ParameterStatus	ystatus
	)

◆ setMidx()

void Sketcher::SolverGeometryExtension::setMidx ( ParameterStatus xstatus )

◆ setMidy()

void Sketcher::SolverGeometryExtension::setMidy ( ParameterStatus ystatus )

◆ setStart()

void Sketcher::SolverGeometryExtension::setStart	(	ParameterStatus	xstatus,
		ParameterStatus	ystatus
	)

◆ setStartx()

void Sketcher::SolverGeometryExtension::setStartx ( ParameterStatus xstatus )

◆ setStarty()

void Sketcher::SolverGeometryExtension::setStarty ( ParameterStatus ystatus )

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

FreeCAD/src/Mod/Sketcher/App/SolverGeometryExtension.h
FreeCAD/src/Mod/Sketcher/App/SolverGeometryExtension.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ ParameterStatus

◆ SolverStatus

Constructor & Destructor Documentation

◆ SolverGeometryExtension()

◆ ~SolverGeometryExtension()

Member Function Documentation

◆ copy()

◆ copyAttributes()

◆ getArc()

◆ getArcOfEllipse()

◆ getArcOfHyperbola()

◆ getArcOfParabola()

◆ getBSpline()

◆ getCircle()

◆ getEdge()

◆ getEdgeParameters()

◆ getEllipse()

◆ getEnd()

◆ getEndPoint()

◆ getGeometry()

◆ getLine()

◆ getMid()

◆ getMidPoint()

◆ getPoint() [1/2]

◆ getPoint() [2/2]

◆ getPyObject()

◆ getStart()

◆ getStartPoint()

◆ init()

◆ notifyAttachment()

◆ setEdge() [1/2]

◆ setEdge() [2/2]

◆ setEnd()

◆ setEndx()

◆ setEndy()

◆ setMid()

◆ setMidx()

◆ setMidy()

◆ setStart()

◆ setStartx()

◆ setStarty()