TechDraw::DrawViewDimension Class Reference

#include <DrawViewDimension.h>

Public Types

enum  RefType {
  invalidRef , oneEdge , twoEdge , twoVertex ,
  vertexEdge , threeVertex
}
 
- Public Types inherited from App::DocumentObject
enum  GSReason { GS_DEFAULT , GS_SELECT }
 reason of calling getSubObjects() More...
 
enum  OutListOption { OutListNoExpression = 1 , OutListNoHidden = 2 , OutListNoXLinked = 4 }
 DAG handling This part of the interface deals with viewing the document as a DAG (directed acyclic graph). More...
 
- Public Types inherited from App::ExtensionContainer
typedef std::map< Base::Type, App::Extension * >::iterator ExtensionIterator
 

Public Member Functions

 DrawViewDimension ()
 Constructor. More...
 
virtual bool has2DReferences (void) const
 
virtual bool has3DReferences (void) const
 
bool hasOverUnderTolerance (void) const
 
short mustExecute () const override
 mustExecute We call this method to check if the object was modified to be invoked. More...
 
virtual ~DrawViewDimension ()
 
- Public Member Functions inherited from TechDraw::DrawView
 DrawView (void)
 Constructor. More...
 
virtual ~DrawView ()
 
virtual App::DocumentObjectExecReturnrecompute () override
 recalculate the Feature More...
 
bool isInClip ()
 
DrawViewClipgetClipGroup (void)
 
virtual DrawPagefindParentPage () const
 
virtual double autoScale (void) const
 
virtual double autoScale (double w, double h) const
 
virtual bool checkFit (void) const
 
virtual bool checkFit (DrawPage *) const
 check if View is too big for page More...
 
virtual void setPosition (double x, double y, bool force=false)
 
virtual bool keepUpdated (void)
 
virtual double getScale (void) const
 
void checkScale (void)
 
void requestPaint (void)
 
virtual void handleXYLock (void)
 
virtual bool isLocked (void) const
 
virtual bool showLock (void) const
 
std::vector< TechDraw::DrawLeaderLine * > getLeaders (void) const
 
- Public Member Functions inherited from App::DocumentObject
virtual App::PropertyaddDynamicProperty (const char *type, const char *name=0, const char *group=0, const char *doc=0, short attr=0, bool ro=false, bool hidden=false) override
 
virtual bool adjustRelativeLinks (const std::set< App::DocumentObject * > &inList, std::set< App::DocumentObject * > *visited=0)
 Called to adjust link properties to avoid cyclic links. More...
 
virtual bool allowDuplicateLabel () const
 
virtual bool canLinkProperties () const
 
virtual int canLoadPartial () const
 allow partial loading of dependent objects More...
 
void clearOutListCache () const
 clear internal out list cache More...
 
virtual const char * detachFromDocument () override
 
 DocumentObject (void)
 Constructor. More...
 
void enforceRecompute ()
 Enforce this document object to be recomputed. More...
 
App::DocumentgetDocument (void) const
 gets the document in which this Object is handled More...
 
std::string getExportName (bool forced=false) const
 returns the name that is safe to be exported to other document More...
 
virtual const PropertyExpressionEngine::ExpressionInfo getExpression (const ObjectIdentifier &path) const
 
virtual std::string getFullName () const override
 Return the object full name of the form DocName::ObjName. More...
 
DocumentObjectGroupgetGroup () const
 get group if object is part of a group, otherwise 0 is returned More...
 
long getID () const
 Return the object ID that is unique within its owner document. More...
 
const std::vector< App::DocumentObject * > & getInList (void) const
 
std::set< App::DocumentObject * > getInListEx (bool recursive) const
 Return a set of all objects linking to this object, including possible external parent objects. More...
 
void getInListEx (std::set< App::DocumentObject * > &inSet, bool recursive, std::vector< App::DocumentObject * > *inList=0) const
 Get a set of all objects linking to this object, including possible external parent objects. More...
 
std::vector< App::DocumentObject * > getInListRecursive (void) const
 get all objects link directly or indirectly to this object More...
 
virtual DocumentObjectgetLinkedObject (bool recurse=true, Base::Matrix4D *mat=0, bool transform=false, int depth=0) const
 Return the linked object with optional transformation. More...
 
const char * getNameInDocument (void) const
 returns the name which is set in the document for this object (not the name property!) More...
 
const std::string & getOldLabel () const
 
const std::vector< App::DocumentObject * > & getOutList () const
 returns a list of objects this object is pointing to by Links More...
 
std::vector< App::DocumentObject * > getOutList (int option) const
 
void getOutList (int option, std::vector< App::DocumentObject * > &res) const
 
std::vector< App::DocumentObject * > getOutListOfProperty (App::Property *) const
 returns a list of objects linked by the property More...
 
std::vector< App::DocumentObject * > getOutListRecursive (void) const
 returns a list of objects this object is pointing to by Links and all further descended More...
 
std::vector< std::pair< App::DocumentObject *, std::string > > getParents (int depth=0) const
 Obtain top parents and subnames of this object using its InList. More...
 
std::vector< std::list< App::DocumentObject * > > getPathsByOutList (App::DocumentObject *to) const
 get all possible paths from this to another object following the OutList More...
 
unsigned long getStatus () const
 return the status bits More...
 
const char * getStatusString (void) const
 get the status Message More...
 
virtual DocumentObjectgetSubObject (const char *subname, PyObject **pyObj=0, Base::Matrix4D *mat=0, bool transform=true, int depth=0) const
 Get the sub element/object by name. More...
 
std::vector< DocumentObject * > getSubObjectList (const char *subname) const
 Return a list of objects referenced by a given subname including this object. More...
 
virtual std::vector< std::string > getSubObjects (int reason=0) const
 Return name reference of all sub-objects. More...
 
virtual const char * getViewProviderNameOverride () const
 This function is introduced to allow Python feature override its view provider. More...
 
const char * getViewProviderNameStored () const
 
virtual bool hasChildElement () const
 return true to activate tree view group object handling and element visibility More...
 
virtual bool isAttachedToDocument () const override
 
virtual int isElementVisible (const char *element) const
 Get sub-element visibility. More...
 
bool isError (void) const
 set this feature to error More...
 
int isExporting () const
 
bool isInInList (DocumentObject *objToTest) const
 test if this object is directly (non recursive) in the InList More...
 
bool isInInListRecursive (DocumentObject *objToTest) const
 test if this object is in the InList and recursive further down More...
 
bool isInOutList (DocumentObject *objToTest) const
 test if this object is directly (non recursive) in the OutList More...
 
bool isInOutListRecursive (DocumentObject *objToTest) const
 test if the given object is in the OutList and recursive further down More...
 
bool isRecomputing () const
 returns true if this objects is currently recomputing More...
 
bool isRemoving () const
 returns true if this objects is currently removed from the document More...
 
bool isRestoring () const
 returns true if this objects is currently restoring from file More...
 
bool isTouched (void) const
 test if this document object is touched More...
 
bool isValid (void) const
 
bool mustRecompute (void) const
 Test if this document object must be recomputed. More...
 
virtual void onBeforeChangeLabel (std::string &newLabel)
 
virtual void onLostLinkToObject (DocumentObject *)
 Called in case of losing a link Get called by the document when a object got deleted a link property of this object ist pointing to. More...
 
virtual void onUpdateElementReference (const Property *)
 
void purgeError (void)
 remove the error from the object More...
 
void purgeTouched (void)
 reset this document object touched More...
 
bool recomputeFeature (bool recursive=false)
 Recompute only this feature. More...
 
virtual bool redirectSubName (std::ostringstream &ss, DocumentObject *topParent, DocumentObject *child) const
 Allow object to redirect a subname path. More...
 
virtual bool removeDynamicProperty (const char *prop) override
 
virtual void renameObjectIdentifiers (const std::map< App::ObjectIdentifier, App::ObjectIdentifier > &paths)
 
App::DocumentObjectresolve (const char *subname, App::DocumentObject **parent=0, std::string *childName=0, const char **subElement=0, PyObject **pyObj=0, Base::Matrix4D *mat=0, bool transform=true, int depth=0) const
 Resolve the last document object referenced in the subname. More...
 
App::DocumentObjectresolveRelativeLink (std::string &subname, App::DocumentObject *&link, std::string &linkSub) const
 Resolve a link reference that is relative to this object reference. More...
 
virtual void Save (Base::Writer &writer) const override
 This method is used to save properties to an XML document. More...
 
virtual int setElementVisible (const char *element, bool visible)
 Child element handling. More...
 
virtual void setExpression (const ObjectIdentifier &path, boost::shared_ptr< App::Expression > expr)
 
void setStatus (ObjectStatus pos, bool on)
 
bool testIfLinkDAGCompatible (App::PropertyLinkSub &linkTo) const
 
bool testIfLinkDAGCompatible (App::PropertyLinkSubList &linksTo) const
 
bool testIfLinkDAGCompatible (const std::vector< DocumentObject * > &linksTo) const
 
bool testIfLinkDAGCompatible (DocumentObject *linkTo) const
 testIfLinkIsDAG tests a link that is about to be created for circular references. More...
 
bool testStatus (ObjectStatus pos) const
 
void touch (bool noRecompute=false)
 Set the property touched -> changed, cause recomputation in Update() More...
 
virtual ~DocumentObject ()
 
- Public Member Functions inherited from App::TransactionalObject
 TransactionalObject (void)
 Constructor. More...
 
virtual ~TransactionalObject ()
 
- Public Member Functions inherited from App::ExtensionContainer
ExtensionIterator extensionBegin ()
 
 ExtensionContainer ()
 
ExtensionIterator extensionEnd ()
 
App::ExtensiongetExtension (Base::Type, bool derived=true, bool no_except=false) const
 
App::ExtensiongetExtension (const std::string &name) const
 
template<typename ExtensionT >
ExtensionTgetExtensionByType (bool no_except=false, bool derived=true) const
 
std::vector< Extension * > getExtensionsDerivedFrom (Base::Type type) const
 
template<typename ExtensionT >
std::vector< ExtensionT * > getExtensionsDerivedFromType () const
 
bool hasExtension (Base::Type, bool derived=true) const
 
bool hasExtension (const std::string &name) const
 
bool hasExtensions () const
 
void registerExtension (Base::Type extension, App::Extension *ext)
 
virtual ~ExtensionContainer ()
 
virtual PropertygetPropertyByName (const char *name) const override
 find a property by its name More...
 
virtual const char * getPropertyName (const Property *prop) const override
 get the name of a property More...
 
virtual void getPropertyMap (std::map< std::string, Property * > &Map) const override
 get all properties of the class (including properties of the parent) More...
 
virtual void getPropertyList (std::vector< Property * > &List) const override
 get all properties of the class (including properties of the parent) More...
 
virtual short getPropertyType (const Property *prop) const override
 get the Type of a Property More...
 
virtual short getPropertyType (const char *name) const override
 get the Type of a named Property More...
 
virtual const char * getPropertyGroup (const Property *prop) const override
 get the Group of a Property More...
 
virtual const char * getPropertyGroup (const char *name) const override
 get the Group of a named Property More...
 
virtual const char * getPropertyDocumentation (const Property *prop) const override
 get the Group of a Property More...
 
virtual const char * getPropertyDocumentation (const char *name) const override
 get the Group of a named Property More...
 
void saveExtensions (Base::Writer &writer) const
 
void restoreExtensions (Base::XMLReader &reader)
 
- Public Member Functions inherited from App::PropertyContainer
virtual App::PropertygetDynamicPropertyByName (const char *name) const
 
DynamicProperty::PropData getDynamicPropertyData (const Property *prop) const
 
virtual std::vector< std::string > getDynamicPropertyNames () 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...
 
const char * getPropertyPrefix () const
 
bool isHidden (const char *name) const
 check if the named property is hidden More...
 
bool isHidden (const Property *prop) const
 check if the property is hidden More...
 
bool isReadOnly (const char *name) const
 check if the named property is read-only More...
 
bool isReadOnly (const Property *prop) const
 check if the property is read-only More...
 
 PropertyContainer ()
 A constructor. More...
 
void setPropertyPrefix (const char *prefix)
 
void setPropertyStatus (unsigned char bit, bool value)
 set the Status bit of all properties at once More...
 
virtual ~PropertyContainer ()
 A destructor. More...
 
- 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...
 

Public Attributes

App::PropertyBool Arbitrary
 
App::PropertyBool ArbitraryTolerances
 
App::PropertyBool EqualTolerance
 
App::PropertyString FormatSpec
 
App::PropertyString FormatSpecOverTolerance
 
App::PropertyString FormatSpecUnderTolerance
 
App::PropertyBool Inverted
 
App::PropertyEnumeration MeasureType
 
App::PropertyQuantityConstraint OverTolerance
 
App::PropertyLinkSubList References2D
 
App::PropertyLinkSubList References3D
 
App::PropertyBool TheoreticalExact
 
App::PropertyEnumeration Type
 
App::PropertyQuantityConstraint UnderTolerance
 
- Public Attributes inherited from TechDraw::DrawView
App::PropertyString Caption
 
App::PropertyBool LockPosition
 
App::PropertyAngle Rotation
 
App::PropertyFloatConstraint Scale
 
App::PropertyEnumeration ScaleType
 
App::PropertyDistance X
 
App::PropertyDistance Y
 
boost::signals2::signal< void(const DrawView *)> signalGuiPaint
 
- Public Attributes inherited from App::DocumentObject
PropertyExpressionEngine ExpressionEngine
 
PropertyString Label
 
PropertyString Label2
 
boost::signals2::signal< void(const App::DocumentObject &, const App::Property &)> signalBeforeChange
 signal before changing a property of this object More...
 
boost::signals2::signal< void(const App::DocumentObject &, const App::Property &)> signalChanged
 signal on changed property of this object More...
 
PropertyBool Visibility
 Allow control visibility status in App name space. More...
 

methods override Feature

Measure::Measurementmeasurement
 
pointPair m_linearPoints
 
pointPair m_arrowPositions
 
virtual App::DocumentObjectExecReturnexecute (void) override
 recalculate the Feature More...
 
virtual const char * getViewProviderName (void) const override
 returns the type name of the ViewProvider More...
 
virtual PyObjectgetPyObject (void) override
 This method returns the Python wrapper for a C++ object. More...
 
virtual std::string getFormattedToleranceValue (int partial)
 
virtual std::pair< std::string, std::string > getFormattedToleranceValues (int partial=0)
 
virtual std::string getFormattedDimensionValue (int partial=0)
 
virtual std::string formatValue (qreal value, QString qFormatSpec, int partial=0)
 
virtual double getDimValue ()
 NOTE: this returns the Dimension value in internal units (ie mm)!!!! More...
 
QStringList getPrefixSuffixSpec (QString fSpec)
 
virtual DrawViewPartgetViewPart () const
 
virtual QRectF getRect () const override
 
virtual int getRefType () const
 
void setAll3DMeasurement ()
 add Dimension 3D references to measurement More...
 
void clear3DMeasurements (void)
 
virtual bool checkReferences2D (void) const
 validate 2D references - only checks if the target exists More...
 
pointPair getLinearPoints (void)
 
arcPoints getArcPoints (void)
 
anglePoints getAnglePoints (void)
 
bool leaderIntersectsArc (Base::Vector3d s, Base::Vector3d pointOnCircle)
 
bool isMultiValueSchema (void) const
 
std::string getBaseLengthUnit (Base::UnitSystem system)
 
pointPair getArrowPositions (void)
 
void saveArrowPositions (const Base::Vector2d positions[])
 
bool showUnits () const
 
bool useDecimals () const
 
static int getRefTypeSubElements (const std::vector< std::string > &)
 
virtual void handleChangedPropertyType (Base::XMLReader &, const char *, App::Property *) override
 PropertyContainer::handleChangedPropertyType is called during restore to possibly fix reading of older versions of the property container. More...
 
virtual void Restore (Base::XMLReader &reader) override
 This method is used to restore properties from an XML document. More...
 
virtual void onChanged (const App::Property *prop) override
 get called by the container when a property was changed More...
 
virtual void onDocumentRestored () override
 get called after a document has been fully restored More...
 
std::string getPrefix () const
 
std::string getDefaultFormatSpec (bool isToleranceFormat=false) const
 
virtual pointPair getPointsOneEdge ()
 
virtual pointPair getPointsTwoEdges ()
 
virtual pointPair getPointsTwoVerts ()
 
virtual pointPair getPointsEdgeVert ()
 
double dist2Segs (Base::Vector3d s1, Base::Vector3d e1, Base::Vector3d s2, Base::Vector3d e2) const
 
pointPair closestPoints (TopoDS_Shape s1, TopoDS_Shape s2) const
 

Additional Inherited Members

- Static Public Member Functions inherited from App::DocumentObject
static const char * hasHiddenMarker (const char *subname)
 Check if the subname reference ends with hidden marker. More...
 
static const std::string & hiddenMarker ()
 Special marker to mark the object as hidden. More...
 
- 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)
 
- Static Public Attributes inherited from App::DocumentObject
static DocumentObjectExecReturnStdReturn
 
- Protected Member Functions inherited from TechDraw::DrawView
int prefScaleType (void)
 
double prefScale (void)
 
- Protected Member Functions inherited from App::DocumentObject
App::DocumentObjectExecReturnexecuteExtensions ()
 Executes the extensions of a document object. More...
 
virtual void onBeforeChange (const Property *prop) override
 get called before the value is changed More...
 
virtual void onPropertyStatusChanged (const Property &prop, unsigned long oldStatus) override
 get called when a property status has changed More...
 
virtual void onSettingDocument ()
 get called after setting the document More...
 
virtual void onUndoRedoFinished ()
 get called after an undo/redo transaction is finished More...
 
void resetError (void)
 
void setDocument (App::Document *doc)
 
void setError (void)
 
virtual void setupObject ()
 get called after a brand new object was created More...
 
virtual void unsetupObject ()
 get called when object is going to be removed from the document More...
 
- Protected Member Functions inherited from App::TransactionalObject
void onBeforeChangeProperty (Document *doc, const Property *prop)
 
- Protected Member Functions inherited from App::PropertyContainer
virtual const PropertyDatagetPropertyData (void) const
 
virtual void handleChangedPropertyName (Base::XMLReader &reader, const char *TypeName, const char *PropName)
 PropertyContainer::handleChangedPropertyName is called during restore to possibly fix reading of older versions of this property container. More...
 
- Static Protected Member Functions inherited from App::PropertyContainer
static const PropertyDatagetPropertyDataPtr (void)
 
- 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 TechDraw::DrawView
std::string pageFeatName
 
bool autoPos
 
bool mouseMove
 
- Protected Attributes inherited from App::DocumentObject
std::string oldLabel
 Old label; used for renaming expressions. More...
 
const std::string * pcNameInDocument
 
Py::Object PythonObject
 python object of this class and all descendent More...
 
std::bitset< 32 > StatusBits
 Status bits of the document object The first 8 bits are used for the base system the rest can be used in descendent classes to mark special statuses on the objects. More...
 
- Protected Attributes inherited from App::PropertyContainer
DynamicProperty dynamicProps
 

Member Enumeration Documentation

◆ RefType

Enumerator
invalidRef 
oneEdge 
twoEdge 
twoVertex 
vertexEdge 
threeVertex 

Constructor & Destructor Documentation

◆ DrawViewDimension()

◆ ~DrawViewDimension()

DrawViewDimension::~DrawViewDimension ( )
virtual

References measurement.

Member Function Documentation

◆ checkReferences2D()

◆ clear3DMeasurements()

void DrawViewDimension::clear3DMeasurements ( void  )

◆ closestPoints()

pointPair DrawViewDimension::closestPoints ( TopoDS_Shape  s1,
TopoDS_Shape  s2 
) const
protected

◆ dist2Segs()

double DrawViewDimension::dist2Segs ( Base::Vector3d  s1,
Base::Vector3d  e1,
Base::Vector3d  s2,
Base::Vector3d  e2 
) const
protected

◆ execute()

App::DocumentObjectExecReturn * DrawViewDimension::execute ( void  )
overridevirtual

recalculate the Feature

Reimplemented from TechDraw::DrawView.

Reimplemented in TechDraw::LandmarkDimension, and TechDraw::DrawViewDimExtent.

References TechDraw::Generic::apparentInter(), TechDraw::arcPoints::arcCW, TechDraw::arcPoints::arcEnds, TechDraw::arcPoints::center, TechDraw::Ellipse::center, checkReferences2D(), Base::Console(), TechDraw::AOE::cw, TechDraw::AOC::cw, TechDraw::BSpline::cw, TechDraw::AOE::endPnt, TechDraw::AOC::endPnt, TechDraw::BSpline::endPnt, TechDraw::anglePoints::ends, Base::ConsoleSingleton::Error(), TechDraw::DrawView::execute(), TechDraw::BaseGeom::geomType, TechDraw::BSpline::getCircleParms(), App::DocumentObject::getDocument(), TechDraw::BaseGeom::getEndPoint(), TechDraw::DrawViewPart::getGeomByIndex(), TechDraw::DrawUtil::getIndexFromName(), App::DocumentObject::getNameInDocument(), getPointsEdgeVert(), getPointsOneEdge(), getPointsTwoEdges(), getPointsTwoVerts(), TechDraw::DrawViewPart::getProjVertexByIndex(), getRefType(), TechDraw::BaseGeom::getStartPoint(), App::PropertyLinkSubList::getSubValues(), getViewPart(), has2DReferences(), TechDraw::arcPoints::isArc, TechDraw::BSpline::isCircle(), App::DocumentObject::isRestoring(), App::PropertyEnumeration::isValue(), TechDraw::DrawView::keepUpdated(), Base::ConsoleSingleton::Log(), m_linearPoints, TechDraw::Ellipse::major, TechDraw::arcPoints::midArc, TechDraw::AOE::midPnt, TechDraw::AOC::midPnt, TechDraw::BSpline::midPnt, TechDraw::Ellipse::minor, TechDraw::arcPoints::onCurve, oneEdge, TechDraw::Vertex::point(), TechDraw::arcPoints::radius, References2D, TechDraw::AOE::startPnt, TechDraw::AOC::startPnt, TechDraw::BSpline::startPnt, App::DocumentObject::StdReturn, App::DocumentObject::testStatus(), threeVertex, twoEdge, twoVertex, Type, TechDraw::anglePoints::vertex, vertexEdge, Base::ConsoleSingleton::Warning(), Base::Vector3< _Precision >::x, and Base::Vector3< _Precision >::y.

Referenced by draftobjects.facebinder.Facebinder::addSubobjects(), PathScripts.PathDressupDogbone.ObjectDressup::boneStateList(), ArchSite.Compass::buildCoordinates(), TechDraw::DrawViewDimExtent::execute(), TechDraw::LandmarkDimension::execute(), PathScripts.PathDressupHoldingTags.ObjectTagDressup::generateTags(), ArchPanel.PanelCut::getWires(), ArchSchedule.CommandArchSchedule::IsActive(), Mod.PartDesign.Scripts.DistanceBolt.DistanceBolt::onChanged(), Mod.PartDesign.Scripts.Epitrochoid.Epitrochoid::onChanged(), Mod.PartDesign.Scripts.Parallelepiped.Parallelepiped::onChanged(), Mod.PartDesign.Scripts.Parallelepiped.BoxCylinder::onChanged(), Mod.PartDesign.Scripts.Spring.MySpring::onChanged(), FeaturePython.DistanceBolt::onChanged(), PathScripts.PathStock.StockFromBase::onChanged(), PathScripts.PathStock.StockCreateBox::onChanged(), PathScripts.PathStock.StockCreateCylinder::onChanged(), draftobjects.draftlink.DraftLink::onDocumentRestored(), draftobjects.patharray.PathArray::onDocumentRestored(), and draftobjects.pathtwistedarray.PathTwistedArray::onDocumentRestored().

◆ formatValue()

◆ getAnglePoints()

anglePoints TechDraw::DrawViewDimension::getAnglePoints ( void  )

◆ getArcPoints()

arcPoints TechDraw::DrawViewDimension::getArcPoints ( void  )

◆ getArrowPositions()

pointPair DrawViewDimension::getArrowPositions ( void  )

◆ getBaseLengthUnit()

◆ getDefaultFormatSpec()

◆ getDimValue()

◆ getFormattedDimensionValue()

◆ getFormattedToleranceValue()

◆ getFormattedToleranceValues()

◆ getLinearPoints()

pointPair TechDraw::DrawViewDimension::getLinearPoints ( void  )

◆ getPointsEdgeVert()

◆ getPointsOneEdge()

◆ getPointsTwoEdges()

◆ getPointsTwoVerts()

◆ getPrefix()

◆ getPrefixSuffixSpec()

QStringList DrawViewDimension::getPrefixSuffixSpec ( QString  fSpec)

◆ getPyObject()

PyObject * DrawViewDimension::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 TechDraw::DrawView.

Reimplemented in TechDraw::DrawViewDimExtent.

References App::DocumentObject::PythonObject.

◆ getRect()

virtual QRectF TechDraw::DrawViewDimension::getRect ( void  ) const
overridevirtual

Reimplemented from TechDraw::DrawView.

◆ getRefType()

int DrawViewDimension::getRefType ( ) const
virtual

◆ getRefTypeSubElements()

int DrawViewDimension::getRefTypeSubElements ( const std::vector< std::string > &  subElements)
static

◆ getViewPart()

◆ getViewProviderName()

virtual const char* TechDraw::DrawViewDimension::getViewProviderName ( void  ) const
overridevirtual

returns the type name of the ViewProvider

Reimplemented from TechDraw::DrawView.

Reimplemented in TechDraw::LandmarkDimension.

◆ handleChangedPropertyType()

void DrawViewDimension::handleChangedPropertyType ( Base::XMLReader reader,
const char *  TypeName,
App::Property prop 
)
overrideprotectedvirtual

PropertyContainer::handleChangedPropertyType is called during restore to possibly fix reading of older versions of the property container.

This method is typically called if the property on file has changed its type in more recent versions.

The default implementation does nothing.

Parameters
readerThe XML stream to read from.
TypeNameName of property type on file.
propPointer to property to restore. Its type differs from TypeName.

Reimplemented from TechDraw::DrawView.

References App::PropertyQuantity::getValue(), TechDraw::DrawView::handleChangedPropertyType(), OverTolerance, App::PropertyFloat::Restore(), App::PropertyQuantity::setValue(), and UnderTolerance.

◆ has2DReferences()

bool DrawViewDimension::has2DReferences ( void  ) const
virtual

◆ has3DReferences()

◆ hasOverUnderTolerance()

◆ isMultiValueSchema()

bool DrawViewDimension::isMultiValueSchema ( void  ) const

◆ leaderIntersectsArc()

◆ mustExecute()

short DrawViewDimension::mustExecute ( ) const
overridevirtual

mustExecute We call this method to check if the object was modified to be invoked.

If the object label or an argument is modified. If we must recompute the object - to call the method execute(). 0: no recomputation is needed 1: recomputation needed

Remarks
If an object is marked as 'touched' then this does not necessarily mean that it will be recomputed. It only means that all objects that link it (i.e. its InList) will be recomputed.

Reimplemented from TechDraw::DrawView.

Reimplemented in TechDraw::LandmarkDimension, and TechDraw::DrawViewDimExtent.

References Arbitrary, ArbitraryTolerances, EqualTolerance, FormatSpec, FormatSpecOverTolerance, FormatSpecUnderTolerance, Inverted, App::DocumentObject::isRestoring(), App::Property::isTouched(), MeasureType, TechDraw::DrawView::mustExecute(), OverTolerance, References2D, TheoreticalExact, Type, and UnderTolerance.

Referenced by TechDraw::DrawViewDimExtent::mustExecute(), and TechDraw::LandmarkDimension::mustExecute().

◆ onChanged()

void DrawViewDimension::onChanged ( const App::Property prop)
overrideprotectedvirtual

get called by the container when a property was changed

Reimplemented from TechDraw::DrawView.

Reimplemented in TechDraw::LandmarkDimension, and TechDraw::DrawViewDimExtent.

References Base::Unit::Angle, Arbitrary, ArbitraryTolerances, clear3DMeasurements(), Base::Console(), EqualTolerance, FormatSpec, FormatSpecOverTolerance, FormatSpecUnderTolerance, getDefaultFormatSpec(), App::DocumentObject::getNameInDocument(), App::PropertyQuantity::getUnit(), App::PropertyEnumeration::getValue(), App::PropertyString::getValue(), App::PropertyBool::getValue(), App::PropertyQuantity::getValue(), App::PropertyLinkSubList::getValues(), Measure::Measurement::has3DReferences(), Inverted, App::DocumentObject::isRestoring(), App::PropertyEnumeration::isValue(), Base::Unit::Length, measurement, MeasureType, TechDraw::DrawView::onChanged(), OverTolerance, References3D, TechDraw::DrawView::requestPaint(), setAll3DMeasurement(), App::PropertyQuantityConstraint::setConstraints(), App::Property::setReadOnly(), App::PropertyQuantity::setUnit(), App::PropertyBool::setValue(), App::PropertyString::setValue(), App::PropertyEnumeration::setValue(), App::PropertyQuantity::setValue(), TheoreticalExact, App::Property::touch(), Type, UnderTolerance, and Base::ConsoleSingleton::Warning().

Referenced by draftviewproviders.view_base.ViewProviderDraft::attach(), ArchSite.Compass::buildCoordinates(), draftobjects.wire.Wire::execute(), ArchAxis.CommandArchGrid::IsActive(), TechDraw::DrawViewDimExtent::onChanged(), TechDraw::LandmarkDimension::onChanged(), ArchBuildingPart.ViewProviderBuildingPart::updateData(), ArchPanel.ViewProviderPanelCut::updateData(), ArchPanel.ViewProviderPanelSheet::updateData(), draftviewproviders.view_label.ViewProviderLabel::updateData(), draftviewproviders.view_layer.ViewProviderLayer::updateData(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy::updateData().

◆ onDocumentRestored()

void DrawViewDimension::onDocumentRestored ( )
overrideprotectedvirtual

◆ Restore()

void DrawViewDimension::Restore ( Base::XMLReader )
overrideprotectedvirtual

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

Reimplemented from App::ExtensionContainer.

References EqualTolerance, App::ExtensionContainer::Restore(), and App::PropertyBool::setValue().

◆ saveArrowPositions()

void DrawViewDimension::saveArrowPositions ( const Base::Vector2d  positions[])

◆ setAll3DMeasurement()

void DrawViewDimension::setAll3DMeasurement ( )

◆ showUnits()

◆ useDecimals()

bool DrawViewDimension::useDecimals ( ) const

Member Data Documentation

◆ Arbitrary

◆ ArbitraryTolerances

◆ EqualTolerance

◆ FormatSpec

◆ FormatSpecOverTolerance

◆ FormatSpecUnderTolerance

◆ Inverted

App::PropertyBool TechDraw::DrawViewDimension::Inverted

◆ m_arrowPositions

pointPair TechDraw::DrawViewDimension::m_arrowPositions
protected

◆ m_linearPoints

◆ measurement

Measure::Measurement* TechDraw::DrawViewDimension::measurement
protected

◆ MeasureType

App::PropertyEnumeration TechDraw::DrawViewDimension::MeasureType

◆ OverTolerance

◆ References2D

◆ References3D

◆ TheoreticalExact

◆ Type

◆ UnderTolerance


The documentation for this class was generated from the following files:
  • Sources/FreeCAD/src/Mod/TechDraw/App/DrawViewDimension.h
  • Sources/FreeCAD/src/Mod/TechDraw/App/DrawViewDimension.cpp