List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Friends
Sketcher::Constraint Class Reference

#include <Constraint.h>

Public Member Functions

Constraint * clone (void) const
 
 Constraint ()
 
 Constraint (Constraint &&)=delete
 
Constraint * copy (void) const
 
virtual unsigned int getMemSize (void) const override
 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::Quantity getPresentationValue () const
 
virtual PyObject * getPyObject (void) override
 This method returns the Python wrapper for a C++ object. More...
 
double getValue () const
 
std::string internalAlignmentTypeToString () const
 
bool isDimensional () const
 
Constraint & operator= (const Constraint &a)=delete
 
Constraint & operator= (Constraint &&)=delete
 
virtual void Restore (Base::XMLReader &) override
 This method is used to restore properties from an XML document. More...
 
virtual void Save (Base::Writer &) const override
 This method is used to save properties to an XML document. More...
 
void setValue (double newValue)
 
void substituteIndex (int fromGeoId, int toGeoId)
 utility function to swap the index in First/Second/Third of the provided constraint from the fromGeoId GeoId to toGeoId More...
 
std::string typeToString () const
 
virtual ~Constraint ()=default
 
- Public Member Functions inherited from Base::Persistence
void dumpToStream (std::ostream &stream, int compression)
 
virtual unsigned int getMemSize () const =0
 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 Base::Type getTypeId (void) const
 
virtual void Restore (XMLReader &)=0
 This method is used to restore properties from an XML document. More...
 
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 Save (Writer &) const =0
 This method is used to save properties to an XML document. More...
 
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...
 
 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...
 

Static Public Member Functions

static std::string internalAlignmentTypeToString (InternalAlignmentType alignment)
 
static std::string typeToString (ConstraintType type)
 
- 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 ()
 
static Type getClassTypeId ()
 
static void init ()
 

Public Attributes

InternalAlignmentType AlignmentType
 
int First
 
PointPos FirstPos
 
int InternalAlignmentIndex
 
bool isActive
 
bool isDriving
 
bool isInVirtualSpace
 
float LabelDistance
 
float LabelPosition
 
std::string Name
 
int Second
 
PointPos SecondPos
 
int Third
 
PointPos ThirdPos
 
ConstraintType Type
 

Protected Attributes

boost::uuids::uuid tag
 

Friends

class PropertyConstraintList
 

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

◆ Constraint() [1/2]

Constraint::Constraint ( )

Referenced by clone(), copy(), and getPyObject().

◆ Constraint() [2/2]

Sketcher::Constraint::Constraint ( Constraint &&  )
delete

◆ ~Constraint()

virtual Sketcher::Constraint::~Constraint ( )
virtualdefault

Member Function Documentation

◆ clone()

Constraint * Constraint::clone ( void  ) const

References Constraint().

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.CommandStructuralSystem::Activated(), Sketcher::SketchObject::addConstraint(), Sketcher::SketchObject::addConstraints(), Sketcher::SketchObject::calculateConstraintError(), Sketcher::SketchObject::changeConstraintsLocking(), Sketcher::SketchObject::delAllExternal(), Sketcher::SketchObject::delExternal(), ArchComponent.Component::execute(), ArchCurtainWall.CurtainWall::execute(), ArchTruss.Truss::execute(), Sketcher::SketchObject::insertBSplineKnot(), Mod.PartDesign.WizardShaft.SegmentFunction.SegmentFunction::integrated(), Sketcher::SketchObject::modifyBSplineKnotMultiplicity(), Sketcher::SketchObject::port_reversedExternalArcs(), Sketcher::SketchObject::renameConstraint(), Sketcher::PropertyConstraintList::set1Value(), Sketcher::SketchObject::setActive(), Sketcher::PropertyConstraintList::setValue(), Sketcher::SketchObject::setVirtualSpace(), PathTests.TestPathHelix.TestPathHelix::test04(), Sketcher::SketchObject::toggleActive(), Sketcher::SketchObject::toggleDriving(), Sketcher::SketchObject::toggleVirtualSpace(), and Sketcher::SketchObject::validateExternalLinks().

◆ copy()

Constraint * Constraint::copy ( void  ) const

References AlignmentType, Constraint(), First, FirstPos, InternalAlignmentIndex, isActive, isDriving, isInVirtualSpace, LabelDistance, LabelPosition, Name, Second, SecondPos, Third, ThirdPos, and Type.

Referenced by Sketcher::SketchObject::addCopy(), Sketcher::SketchObject::addSymmetric(), Sketcher::SketchObject::carbonCopy(), and Sketcher::SketchObject::split().

◆ getMemSize()

unsigned int Constraint::getMemSize ( void  ) const
overridevirtual

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.

◆ getPresentationValue()

Quantity Constraint::getPresentationValue ( ) const

References Sketcher::Angle, Sketcher::Diameter, Sketcher::Distance, Sketcher::DistanceX, Sketcher::DistanceY, Base::Quantity::getFormat(), Base::QuantityFormat::option, Sketcher::Radius, Base::Quantity::setFormat(), Base::Quantity::setUnit(), Base::Quantity::setValue(), Sketcher::SnellsLaw, and Sketcher::Weight.

Referenced by ConstraintItem::data(), and Sketcher::PropertyConstraintList::getPyPathValue().

◆ getPyObject()

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

Reimplemented from Base::BaseClass.

References Constraint().

◆ getValue()

double Sketcher::Constraint::getValue ( void  ) const

Referenced by Sketcher::Sketch::addConstraint(), SketcherGui::EditDatumDialog::exec(), and SketcherGui::EditModeConstraintCoinManager::processConstraints().

◆ internalAlignmentTypeToString() [1/2]

std::string Sketcher::Constraint::internalAlignmentTypeToString ( ) const

References internalAlignmentTypeToString().

Referenced by internalAlignmentTypeToString().

◆ internalAlignmentTypeToString() [2/2]

std::string Constraint::internalAlignmentTypeToString ( InternalAlignmentType  alignment)
static

◆ isDimensional()

bool Sketcher::Constraint::isDimensional ( ) const

References Sketcher::Angle, Sketcher::Diameter, Sketcher::Distance, Sketcher::DistanceX, Sketcher::DistanceY, Sketcher::Radius, Sketcher::SnellsLaw, and Sketcher::Weight.

Referenced by SketcherGui::ViewProviderSketch::editDoubleClicked(), and SketcherGui::EditDatumDialog::exec().

◆ operator=() [1/2]

Constraint & Sketcher::Constraint::operator= ( const Constraint &  a)
delete

◆ operator=() [2/2]

Constraint & Sketcher::Constraint::operator= ( Constraint &&  )
delete

◆ Restore()

void Constraint::Restore ( Base::XMLReader &  )
overridevirtual

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

Implements Base::Persistence.

References AlignmentType, First, FirstPos, Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsFloat(), Base::XMLReader::getAttributeAsInteger(), Base::XMLReader::hasAttribute(), Sketcher::InternalAlignment, InternalAlignmentIndex, isActive, isDriving, isInVirtualSpace, LabelDistance, LabelPosition, Name, Base::XMLReader::readElement(), Second, SecondPos, Third, ThirdPos, and Sketcher::Undef.

Referenced by Sketcher::PropertyConstraintList::Restore().

◆ Save()

void Constraint::Save ( Base::Writer &  ) const
overridevirtual

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 AlignmentType, Base::Persistence::encodeAttribute(), First, FirstPos, Base::Writer::ind(), Sketcher::InternalAlignment, InternalAlignmentIndex, isActive, isDriving, isInVirtualSpace, LabelDistance, LabelPosition, Name, Second, SecondPos, Base::Writer::Stream(), Third, and ThirdPos.

◆ setValue()

void Sketcher::Constraint::setValue ( double  newValue)

Referenced by Sketcher::SketchObject::addCopy(), and Sketcher::SketchObject::addSymmetric().

◆ substituteIndex()

void Constraint::substituteIndex ( int  fromGeoId,
int  toGeoId 
)

utility function to swap the index in First/Second/Third of the provided constraint from the fromGeoId GeoId to toGeoId

References First, Second, and Third.

Referenced by Sketcher::SketchObject::split().

◆ typeToString() [1/2]

std::string Sketcher::Constraint::typeToString ( ) const

References typeToString().

Referenced by typeToString().

◆ typeToString() [2/2]

std::string Constraint::typeToString ( ConstraintType  type)
static

Friends And Related Function Documentation

◆ PropertyConstraintList

friend class PropertyConstraintList
friend

Member Data Documentation

◆ AlignmentType

InternalAlignmentType Sketcher::Constraint::AlignmentType

Referenced by Sketcher::Sketch::addConstraint(), copy(), ConstraintItem::data(), Sketcher::SketchObject::exposeInternalGeometry(), Sketcher::SketchObject::getInternalTypeState(), Restore(), Save(), and SketcherGui::EditModeConstraintCoinManager::updateConstraintColor().

◆ First

int Sketcher::Constraint::First

Referenced by Sketcher::Sketch::addConstraint(), Sketcher::SketchObject::addCopy(), Sketcher::SketchObject::addSymmetric(), Sketcher::SketchObject::calculateConstraintError(), Sketcher::SketchObject::carbonCopy(), copy(), ConstraintItem::data(), Sketcher::SketchObject::delExternal(), Sketcher::SketchObject::delGeometriesExclusiveList(), SketcherGui::EditModeConstraintCoinManager::drawConstraintIcons(), Sketcher::SketchObject::evaluateConstraint(), Sketcher::SketchObject::exposeInternalGeometry(), Sketcher::SketchObject::fillet(), ConstraintItem::isEnforceable(), Sketcher::SketchObject::port_reversedExternalArcs(), SketcherGui::EditModeConstraintCoinManager::processConstraints(), Restore(), Save(), Sketcher::SketchObject::split(), substituteIndex(), Sketcher::SketchObject::synchroniseGeometryState(), Sketcher::SketchObject::transferFilletConstraints(), Sketcher::SketchObject::trim(), SketcherGui::EditModeConstraintCoinManager::updateConstraintColor(), and Sketcher::SketchObject::validateExternalLinks().

◆ FirstPos

PointPos Sketcher::Constraint::FirstPos

Referenced by Sketcher::Sketch::addConstraint(), Sketcher::SketchObject::addCopy(), Sketcher::SketchObject::addSymmetric(), copy(), ConstraintItem::data(), SketcherGui::EditModeConstraintCoinManager::drawConstraintIcons(), Sketcher::SketchObject::exposeInternalGeometry(), Sketcher::SketchObject::fillet(), Sketcher::SketchObject::port_reversedExternalArcs(), SketcherGui::EditModeConstraintCoinManager::processConstraints(), Restore(), Save(), Sketcher::SketchObject::split(), Sketcher::SketchObject::transferFilletConstraints(), Sketcher::SketchObject::trim(), and SketcherGui::EditModeConstraintCoinManager::updateConstraintColor().

◆ InternalAlignmentIndex

int Sketcher::Constraint::InternalAlignmentIndex

Referenced by Sketcher::Sketch::addConstraint(), copy(), Sketcher::SketchObject::exposeInternalGeometry(), Sketcher::SketchObject::insertBSplineKnot(), Sketcher::SketchObject::modifyBSplineKnotMultiplicity(), Restore(), and Save().

◆ isActive

bool Sketcher::Constraint::isActive

Referenced by copy(), ConstraintItem::data(), Restore(), Save(), Sketcher::SketchObject::setActive(), Sketcher::SketchObject::toggleActive(), and SketcherGui::EditModeConstraintCoinManager::updateConstraintColor().

◆ isDriving

bool Sketcher::Constraint::isDriving

Referenced by Sketcher::Sketch::addConstraint(), Sketcher::SketchObject::addCopy(), copy(), ConstraintItem::data(), SketcherGui::EditDatumDialog::exec(), ExpressionDelegate::paint(), Restore(), Save(), Sketcher::SketchObject::toggleDriving(), SketcherGui::EditModeConstraintCoinManager::updateConstraintColor(), and Sketcher::SketchObject::validateExpression().

◆ isInVirtualSpace

bool Sketcher::Constraint::isInVirtualSpace

Referenced by copy(), SketcherGui::EditModeConstraintCoinManager::drawConstraintIcons(), Restore(), Save(), Sketcher::SketchObject::setVirtualSpace(), and Sketcher::SketchObject::toggleVirtualSpace().

◆ LabelDistance

float Sketcher::Constraint::LabelDistance

Referenced by copy(), SketcherGui::EditModeConstraintCoinManager::processConstraints(), Restore(), and Save().

◆ LabelPosition

float Sketcher::Constraint::LabelPosition

Referenced by copy(), SketcherGui::EditModeConstraintCoinManager::processConstraints(), Restore(), and Save().

◆ Name

std::string Sketcher::Constraint::Name

Referenced by copy(), ConstraintItem::data(), SketcherGui::EditModeConstraintCoinManager::drawConstraintIcons(), SketcherGui::EditDatumDialog::exec(), SketcherGui::TaskSketcherConstraints::on_listWidgetConstraints_itemChanged(), Sketcher::SketchObject::renameConstraint(), Restore(), Save(), and Sketcher::PropertyConstraintList::set1Value().

◆ Second

int Sketcher::Constraint::Second

Referenced by Sketcher::Sketch::addConstraint(), Sketcher::SketchObject::addCopy(), Sketcher::SketchObject::addSymmetric(), Sketcher::SketchObject::calculateConstraintError(), Sketcher::SketchObject::carbonCopy(), copy(), ConstraintItem::data(), Sketcher::SketchObject::delExternal(), Sketcher::SketchObject::delGeometriesExclusiveList(), SketcherGui::EditModeConstraintCoinManager::drawConstraintIcons(), Sketcher::SketchObject::evaluateConstraint(), Sketcher::SketchObject::exposeInternalGeometry(), Sketcher::SketchObject::fillet(), ConstraintItem::isEnforceable(), Sketcher::SketchObject::port_reversedExternalArcs(), SketcherGui::EditModeConstraintCoinManager::processConstraints(), Restore(), Save(), Sketcher::SketchObject::split(), substituteIndex(), Sketcher::SketchObject::transferFilletConstraints(), Sketcher::SketchObject::trim(), SketcherGui::EditModeConstraintCoinManager::updateConstraintColor(), and Sketcher::SketchObject::validateExternalLinks().

◆ SecondPos

PointPos Sketcher::Constraint::SecondPos

Referenced by Sketcher::Sketch::addConstraint(), Sketcher::SketchObject::addCopy(), Sketcher::SketchObject::addSymmetric(), copy(), ConstraintItem::data(), SketcherGui::EditModeConstraintCoinManager::drawConstraintIcons(), Sketcher::SketchObject::exposeInternalGeometry(), Sketcher::SketchObject::fillet(), Sketcher::SketchObject::port_reversedExternalArcs(), SketcherGui::EditModeConstraintCoinManager::processConstraints(), Restore(), Save(), Sketcher::SketchObject::split(), Sketcher::SketchObject::transferFilletConstraints(), Sketcher::SketchObject::trim(), and SketcherGui::EditModeConstraintCoinManager::updateConstraintColor().

◆ tag

boost::uuids::uuid Sketcher::Constraint::tag
protected

Referenced by PathScripts.PathDressupHoldingTags.MapWireToTag::add(), PathScripts.PathDressupHoldingTags.MapWireToTag::cleanupEdges(), PathScripts.PathDressupHoldingTags.MapWireToTag::commandsForEdges(), Dice3DS.dom3ds.ChunkBase::document_html(), Dice3DS.dom3ds.ChunkBase::dump_header(), ArchPanel.PanelCut::getWires(), Sketcher::PropertyConstraintList::set1Value(), Sketcher::PropertyConstraintList::setValue(), PathScripts.PathDressupHoldingTags.MapWireToTag::shell(), and FreeCADInit.FCADLogger::trace().

◆ Third

int Sketcher::Constraint::Third

Referenced by Sketcher::Sketch::addConstraint(), Sketcher::SketchObject::addCopy(), Sketcher::SketchObject::addSymmetric(), Sketcher::SketchObject::calculateConstraintError(), Sketcher::SketchObject::carbonCopy(), copy(), ConstraintItem::data(), Sketcher::SketchObject::delExternal(), Sketcher::SketchObject::delGeometriesExclusiveList(), SketcherGui::EditModeConstraintCoinManager::drawConstraintIcons(), Sketcher::SketchObject::evaluateConstraint(), ConstraintItem::isEnforceable(), Sketcher::SketchObject::port_reversedExternalArcs(), SketcherGui::EditModeConstraintCoinManager::processConstraints(), Restore(), Save(), substituteIndex(), and Sketcher::SketchObject::validateExternalLinks().

◆ ThirdPos

PointPos Sketcher::Constraint::ThirdPos

Referenced by Sketcher::Sketch::addConstraint(), Sketcher::SketchObject::addSymmetric(), copy(), ConstraintItem::data(), Sketcher::SketchObject::port_reversedExternalArcs(), SketcherGui::EditModeConstraintCoinManager::processConstraints(), Restore(), and Save().

◆ Type

ConstraintType Sketcher::Constraint::Type

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.CommandStructuralSystem::Activated(), draftobjects.draft_annotation.DraftAnnotation::add_missing_properties_0v19(), Sketcher::Sketch::addConstraint(), Sketcher::SketchObject::addConstraint(), Sketcher::SketchObject::addConstraints(), Sketcher::SketchObject::addCopy(), ArchStructure.StructSelectionObserver::addSelection(), Sketcher::SketchObject::addSymmetric(), ArchSite.Compass::buildCoordinates(), copy(), ConstraintItem::data(), SketcherGui::EditModeConstraintCoinManager::drawConstraintIcons(), Sketcher::SketchObject::evaluateConstraint(), SketcherGui::EditDatumDialog::exec(), ArchComponent.Component::execute(), draftobjects.layer.LayerContainer::execute(), Sketcher::SketchObject::exposeInternalGeometry(), Sketcher::SketchObject::fillet(), Sketcher::SketchObject::getBlockedState(), Sketcher::SketchObject::getInternalTypeState(), ArchSchedule.CommandArchSchedule::IsActive(), ConstraintItem::isEnforceable(), SketcherGui::EditModeConstraintCoinManager::processConstraints(), Sketcher::PropertyConstraintList::Restore(), draftobjects.layer.Layer::set_properties(), ArchReference.ArchReference::setProperties(), Sketcher::SketchObject::split(), Sketcher::SketchObject::transferFilletConstraints(), Sketcher::SketchObject::trim(), and SketcherGui::EditModeConstraintCoinManager::updateConstraintColor().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.4