Sketcher::SolverGeometryExtension Class Reference

#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::GeometryExtensioncopy (void) const override
 
ArcgetArc ()
 
ArcOfEllipsegetArcOfEllipse ()
 
ArcOfHyperbolagetArcOfHyperbola ()
 
ArcOfParabolagetArcOfParabola ()
 
BSplinegetBSpline ()
 
CirclegetCircle ()
 
ParameterStatus getEdge () const
 
EdgeParameterStatus getEdgeParameters ()
 
EllipsegetEllipse ()
 
ParameterStatus getEnd () const
 
PointParameterStatus getEndPoint () const
 
SolverStatus getGeometry () const
 
LinegetLine ()
 
ParameterStatus getMid () const
 
PointParameterStatus getMidPoint () const
 
PointgetPoint ()
 
PointParameterStatus getPoint (Sketcher::PointPos pos) const
 
virtual PyObjectgetPyObject (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< GeometryExtensioncopy (void) const =0
 
PyObjectcopyPyObject () const
 
const std::string & getName () const
 
virtual PyObjectgetPyObject (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 PyObjectgetPyObject ()
 This method returns the Python wrapper for a C++ object. More...
 
virtual Type getTypeId () const
 
bool isDerivedFrom (const Type type) const
 
BaseClassoperator= (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
 
GeometryExtensionoperator= (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

Enumerator
Dependent 
Independent 
NumParameterStatus 

◆ 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

◆ 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 ( )

◆ getArcOfEllipse()

SolverGeometryExtension::ArcOfEllipse & SolverGeometryExtension::getArcOfEllipse ( )

◆ getArcOfHyperbola()

SolverGeometryExtension::ArcOfHyperbola & SolverGeometryExtension::getArcOfHyperbola ( )

◆ getArcOfParabola()

SolverGeometryExtension::ArcOfParabola & SolverGeometryExtension::getArcOfParabola ( )

◆ getBSpline()

SolverGeometryExtension::BSpline & SolverGeometryExtension::getBSpline ( )

◆ getCircle()

SolverGeometryExtension::Circle & SolverGeometryExtension::getCircle ( )

◆ getEdge()

ParameterStatus Sketcher::SolverGeometryExtension::getEdge ( ) const

◆ getEdgeParameters()

EdgeParameterStatus Sketcher::SolverGeometryExtension::getEdgeParameters ( )

◆ getEllipse()

SolverGeometryExtension::Ellipse & SolverGeometryExtension::getEllipse ( )

◆ 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 ( )

◆ getMid()

ParameterStatus Sketcher::SolverGeometryExtension::getMid ( ) const

◆ getMidPoint()

PointParameterStatus Sketcher::SolverGeometryExtension::getMidPoint ( ) const

Referenced by getPoint().

◆ getPoint() [1/2]

◆ getPoint() [2/2]

◆ 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)

◆ notifyAttachment()

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

◆ 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: