TechDraw::DrawViewDetail Class Reference

#include <DrawViewDetail.h>

Public Member Functions

void detailExec (TopoDS_Shape s, DrawViewPart *baseView, DrawViewSection *sectionAlias)
 
 DrawViewDetail (void)
 Constructor. More...
 
virtual App::DocumentObjectExecReturnexecute (void) override
 recalculate the Feature More...
 
virtual std::vector< DrawViewDetail * > getDetailRefs () const override
 
double getFudgeRadius (void)
 
virtual const char * getViewProviderName (void) const override
 returns the type name of the ViewProvider More...
 
virtual short mustExecute () const override
 mustExecute We call this method to check if the object was modified to be invoked. More...
 
virtual void onChanged (const App::Property *prop) override
 get called by the container when a property was changed More...
 
TopoDS_Shape projectEdgesOntoFace (TopoDS_Shape edgeShape, TopoDS_Face projFace, gp_Dir projDir)
 
virtual void unsetupObject () override
 remove features that are useless without this DVP hatches, geomhatches, dimensions,... More...
 
virtual ~DrawViewDetail ()
 
- Public Member Functions inherited from TechDraw::DrawViewPart
int add1CEToGE (std::string tag)
 
int add1CLToGE (std::string tag)
 
int add1CVToGV (std::string tag)
 
void addCenterLinesToGeom (void)
 
void addCosmeticEdgesToGeom (void)
 
void addCosmeticVertexesToGeom (void)
 
void addReferencesToGeom (void)
 
std::string addReferenceVertex (Base::Vector3d v)
 
void clearCenterLines (void)
 
void clearCosmeticEdges (void)
 
void clearCosmeticVertexes (void)
 
void clearGeomFormats (void)
 
 DrawViewPart (void)
 
void dumpCosEdges (const std::string text)
 
void dumpCosVerts (const std::string text)
 
void dumpVerts (const std::string text)
 
virtual App::DocumentObjectExecReturnexecute (void) override
 recalculate the Feature More...
 
std::vector< App::DocumentObject * > getAllSources (void) const
 
std::vector< TechDraw::DrawViewBalloon * > getBalloons () const
 
virtual Base::BoundBox3d getBoundingBox () const
 
double getBoxX (void) const
 
double getBoxY (void) const
 
virtual Base::Vector3d getCurrentCentroid (void) const
 
int getCVIndex (std::string tag)
 
virtual std::vector< DrawViewDetail * > getDetailRefs () const
 
std::vector< TechDraw::DrawViewDimension * > getDimensions () const
 
const BaseGeomPtrVector getEdgeGeometry () const
 
std::vector< TechDraw::BaseGeomPtrgetFaceEdgesByIndex (int idx) const
 returns existing geometry of 2D Face(idx) More...
 
const std::vector< TechDraw::FacePtrgetFaceGeometry () const
 
TechDraw::BaseGeomPtr getGeomByIndex (int idx) const
 returns existing BaseGeom of 2D Edge(idx) More...
 
TechDraw::GeometryObjectgetGeometryObject (void) const
 
std::vector< TechDraw::DrawGeomHatch * > getGeomHatches (void) const
 
std::vector< TechDraw::DrawHatch * > getHatches (void) const
 
virtual Base::Vector3d getLegacyX (const Base::Vector3d &pt, const Base::Vector3d &axis, const bool flip=true) const
 
virtual Base::Vector3d getOriginalCentroid (void) const
 
virtual gp_Ax2 getProjectionCS (Base::Vector3d pt) const
 
TechDraw::VertexPtr getProjVertexByCosTag (std::string cosTag)
 
TechDraw::VertexPtr getProjVertexByIndex (int idx) const
 returns existing geometry of 2D Vertex(idx) More...
 
virtual PyObjectgetPyObject (void) override
 This method returns the Python wrapper for a C++ object. More...
 
virtual QRectF getRect () const override
 
virtual std::vector< DrawViewSection * > getSectionRefs () const
 
virtual TopoDS_Shape getSourceShape (void) const
 
virtual std::vector< TopoDS_Shape > getSourceShape2d (void) const
 
virtual TopoDS_Shape getSourceShapeFused (void) const
 
const std::vector< TechDraw::VertexPtrgetVertexGeometry () const
 
virtual gp_Ax2 getViewAxis (const Base::Vector3d &pt, const Base::Vector3d &direction, const bool flip=true) const
 
virtual const char * getViewProviderName (void) const override
 returns the type name of the ViewProvider More...
 
const BaseGeomPtrVector getVisibleFaceEdges () const
 
virtual std::vector< TopoDS_Wire > getWireForFace (int idx) const
 
virtual Base::Vector3d getXDirection (void) const
 
bool handleFaces (void)
 
bool hasGeometry (void) const
 
bool isIso (void) const
 is this an Isometric projection? More...
 
bool isUnsetting (void)
 
virtual short mustExecute () const override
 mustExecute We call this method to check if the object was modified to be invoked. More...
 
virtual void onDocumentRestored () override
 get called after a document has been fully restored More...
 
virtual BaseGeomPtr projectEdge (const TopoDS_Edge &e) const
 
virtual Base::Vector3d projectPoint (const Base::Vector3d &pt, bool invert=true) const
 
void refreshCEGeoms (void)
 
void refreshCLGeoms (void)
 
void refreshCVGeoms (void)
 
void removeAllReferencesFromGeom ()
 
void removeReferenceVertex (std::string tag)
 
void resetReferenceVerts ()
 
void updateReferenceVert (std::string tag, Base::Vector3d loc2d)
 
virtual ~DrawViewPart ()
 
- Public Member Functions inherited from TechDraw::DrawView
 DrawView (void)
 Constructor. More...
 
virtual ~DrawView ()
 
virtual void handleChangedPropertyType (Base::XMLReader &reader, const char *TypeName, App::Property *prop) override
 PropertyContainer::handleChangedPropertyType is called during restore to possibly fix reading of older versions of the property container. More...
 
bool isInClip ()
 
DrawViewClipgetClipGroup (void)
 
virtual DrawPagefindParentPage () const
 
virtual std::vector< DrawPage * > findAllParentPages () const
 
virtual int countParentPages () const
 DrawView::countParentPages Fixes a crash in TechDraw when user creates duplicate page without dependencies In fixOrphans() we check how many parent pages an object has before deleting in case it is also a child of another duplicate page. More...
 
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
 
void setScaleAttribute ()
 
- Public Member Functions inherited from App::DocumentObject
virtual App::PropertyaddDynamicProperty (const char *type, const char *name=nullptr, const char *group=nullptr, const char *doc=nullptr, short attr=0, bool ro=false, bool hidden=false) override
 
virtual bool adjustRelativeLinks (const std::set< App::DocumentObject * > &inList, std::set< App::DocumentObject * > *visited=nullptr)
 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 clearExpression (const ObjectIdentifier &path)
 
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=nullptr) 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=nullptr, 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...
 
virtual PyObjectgetPyObject (void) override
 This method returns the Python wrapper for a C++ object. 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=nullptr, Base::Matrix4D *mat=nullptr, 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 * getViewProviderName (void) const
 returns the type name of the ViewProvider 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
 
virtual short mustExecute (void) const
 mustExecute We call this method to check if the object was modified to be invoked. More...
 
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=nullptr, std::string *childName=nullptr, const char **subElement=nullptr, PyObject **pyObj=nullptr, Base::Matrix4D *mat=nullptr, 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, std::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
virtual const char * detachFromDocument ()
 
virtual bool isAttachedToDocument () const
 
 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...
 
virtual void Restore (Base::XMLReader &reader) override
 This method is used to restore properties from an XML document. More...
 
void saveExtensions (Base::Writer &writer) const
 
void restoreExtensions (Base::XMLReader &reader)
 
- Public Member Functions inherited from App::PropertyContainer
virtual App::PropertyaddDynamicProperty (const char *type, const char *name=nullptr, const char *group=nullptr, const char *doc=nullptr, short attr=0, bool ro=false, bool hidden=false)
 
bool changeDynamicProperty (const Property *prop, const char *group, const char *doc)
 
virtual void editProperty (const char *)
 
virtual App::PropertygetDynamicPropertyByName (const char *name) const
 
DynamicProperty::PropData getDynamicPropertyData (const Property *prop) const
 
virtual std::vector< std::string > getDynamicPropertyNames () const
 
virtual std::string getFullName () 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...
 
virtual PropertygetPropertyByName (const char *name) const
 find a property by its name More...
 
virtual const char * getPropertyDocumentation (const char *name) const
 get the Group of a named Property More...
 
virtual const char * getPropertyDocumentation (const Property *prop) const
 get the Group of a Property More...
 
virtual const char * getPropertyGroup (const char *name) const
 get the Group of a named Property More...
 
virtual const char * getPropertyGroup (const Property *prop) const
 get the Group of a Property More...
 
virtual void getPropertyList (std::vector< Property * > &List) const
 get all properties of the class (including properties of the parent) More...
 
virtual void getPropertyMap (std::map< std::string, Property * > &Map) const
 get all properties of the class (including properties of the parent) More...
 
virtual const char * getPropertyName (const Property *prop) const
 get the name of a property More...
 
virtual void getPropertyNamedList (std::vector< std::pair< const char *, Property * > > &List) const
 get all properties with their names, may contain duplicates and aliases More...
 
const char * getPropertyPrefix () const
 
virtual short getPropertyType (const char *name) const
 get the Type of a named Property More...
 
virtual short getPropertyType (const Property *prop) const
 get the Type of a Property More...
 
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...
 
virtual void onPropertyStatusChanged (const Property &prop, unsigned long oldStatus)
 
 PropertyContainer ()
 A constructor. More...
 
virtual bool removeDynamicProperty (const char *name)
 
virtual void Restore (Base::XMLReader &reader)
 This method is used to restore properties from an XML document. More...
 
virtual void Save (Base::Writer &writer) const
 This method is used to save properties to an XML document. 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 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 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...
 
- Public Member Functions inherited from TechDraw::CosmeticExtension
virtual std::string addCenterLine (Base::Vector3d start, Base::Vector3d end)
 
virtual std::string addCenterLine (TechDraw::BaseGeomPtr bg)
 
virtual std::string addCenterLine (TechDraw::CenterLine *cl)
 
virtual std::string addCosmeticEdge (Base::Vector3d start, Base::Vector3d end)
 
virtual std::string addCosmeticEdge (TechDraw::BaseGeomPtr bg)
 
virtual std::string addCosmeticVertex (Base::Vector3d pos)
 
virtual std::string addGeomFormat (TechDraw::GeomFormat *gf)
 
 CosmeticExtension ()
 
virtual CenterLinegetCenterLine (std::string tag) const
 
virtual CenterLinegetCenterLineBySelection (int i) const
 
virtual CenterLinegetCenterLineBySelection (std::string name) const
 
virtual CosmeticEdgegetCosmeticEdge (std::string id) const
 
virtual CosmeticEdgegetCosmeticEdgeBySelection (int i) const
 
virtual CosmeticEdgegetCosmeticEdgeBySelection (std::string name) const
 
virtual CosmeticVertexgetCosmeticVertex (std::string id) const
 
virtual CosmeticVertexgetCosmeticVertexBySelection (int i) const
 
virtual CosmeticVertexgetCosmeticVertexBySelection (std::string name) const
 
PyObjectgetExtensionPyObject (void)
 
virtual GeomFormatgetGeomFormat (std::string id) const
 
virtual GeomFormatgetGeomFormatBySelection (int i) const
 
virtual GeomFormatgetGeomFormatBySelection (std::string name) const
 
virtual void removeCenterLine (std::string tag)
 
virtual void removeCenterLine (std::vector< std::string > delTags)
 
virtual void removeCosmeticEdge (std::string tag)
 
virtual void removeCosmeticEdge (std::vector< std::string > delTags)
 
virtual void removeCosmeticVertex (std::string tag)
 
virtual void removeCosmeticVertex (std::vector< std::string > delTags)
 
virtual void removeGeomFormat (std::string tag)
 
virtual bool replaceCenterLine (CenterLine *newLine)
 
virtual bool replaceCosmeticEdge (CosmeticEdge *newEdge)
 
virtual bool replaceCosmeticVertex (CosmeticVertex *newVertex)
 
virtual bool replaceGeomFormat (TechDraw::GeomFormat *gf)
 
virtual ~CosmeticExtension ()
 
- Public Member Functions inherited from App::DocumentObjectExtension
 DocumentObjectExtension ()
 
virtual App::DocumentObjectExecReturnextensionExecute ()
 
virtual bool extensionGetLinkedObject (DocumentObject *&ret, bool recursive, Base::Matrix4D *mat, bool transform, int depth) const
 Get the linked object. More...
 
virtual bool extensionGetSubObject (DocumentObject *&ret, const char *subname, PyObject **pyObj, Base::Matrix4D *mat, bool transform, int depth) const
 Get the sub object by name. More...
 
virtual bool extensionGetSubObjects (std::vector< std::string > &ret, int reason) const
 Get name references of all sub objects. More...
 
virtual bool extensionHasChildElement () const
 
virtual int extensionIsElementVisible (const char *)
 
virtual short extensionMustExecute ()
 
virtual int extensionSetElementVisible (const char *, bool)
 
App::DocumentObjectgetExtendedObject ()
 
const App::DocumentObjectgetExtendedObject () const
 
virtual PyObjectgetExtensionPyObject () override
 
virtual const char * getViewProviderExtensionName () const
 returns the type name of the ViewProviderExtension which is automatically attached to the viewprovider object when it is initiated More...
 
virtual void onExtendedDocumentRestored ()
 get called after a document has been fully restored More...
 
virtual void onExtendedSettingDocument ()
 get called after setting the document More...
 
virtual void onExtendedSetupObject ()
 get called after a brand new object was created More...
 
virtual void onExtendedUnsetupObject ()
 get called when object is going to be removed from the document More...
 
virtual ~DocumentObjectExtension ()
 
- Public Member Functions inherited from App::Extension
 Extension ()
 
App::ExtensionContainergetExtendedContainer ()
 
const App::ExtensionContainergetExtendedContainer () const
 
virtual PyObjectgetExtensionPyObject ()
 
virtual void initExtension (App::ExtensionContainer *obj)
 
bool isPythonExtension ()
 
std::string name () const
 
virtual ~Extension ()
 
virtual PropertyextensionGetPropertyByName (const char *name) const
 find a property by its name More...
 
virtual const char * extensionGetPropertyName (const Property *prop) const
 get the name of a property More...
 
virtual void extensionGetPropertyMap (std::map< std::string, Property * > &Map) const
 get all properties of the class (including properties of the parent) More...
 
virtual void extensionGetPropertyList (std::vector< Property * > &List) const
 get all properties of the class (including properties of the parent) More...
 
virtual short extensionGetPropertyType (const Property *prop) const
 get the Type of a Property More...
 
virtual short extensionGetPropertyType (const char *name) const
 get the Type of a named Property More...
 
virtual const char * extensionGetPropertyGroup (const Property *prop) const
 get the Group of a Property More...
 
virtual const char * extensionGetPropertyGroup (const char *name) const
 get the Group of a named Property More...
 
virtual const char * extensionGetPropertyDocumentation (const Property *prop) const
 get the Group of a Property More...
 
virtual const char * extensionGetPropertyDocumentation (const char *name) const
 get the Group of a named Property More...
 
virtual void extensionSave (Base::Writer &) const
 
virtual void extensionRestore (Base::XMLReader &)
 
bool extensionIsDerivedFrom (const Base::Type type) const
 

Public Attributes

App::PropertyVector AnchorPoint
 
App::PropertyLink BaseView
 
App::PropertyFloat Radius
 
App::PropertyString Reference
 
- Public Attributes inherited from TechDraw::DrawViewPart
App::PropertyBool CoarseView
 
App::PropertyVector Direction
 
App::PropertyDistance Focus
 
App::PropertyBool HardHidden
 
App::PropertyInteger IsoCount
 
App::PropertyBool IsoHidden
 
App::PropertyBool IsoVisible
 
App::PropertyBool Perspective
 
App::PropertyBool SeamHidden
 
App::PropertyBool SeamVisible
 
App::PropertyBool SmoothHidden
 
App::PropertyBool SmoothVisible
 
App::PropertyLinkList Source
 
App::PropertyVector XDirection
 
App::PropertyXLinkList XSource
 
- 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...
 
- Public Attributes inherited from TechDraw::CosmeticExtension
TechDraw::PropertyCenterLineList CenterLines
 
TechDraw::PropertyCosmeticEdgeList CosmeticEdges
 
TechDraw::PropertyCosmeticVertexList CosmeticVertexes
 
TechDraw::PropertyGeomFormatList GeomFormats
 

Protected Member Functions

bool debugDetail (void) const
 
void getParameters (void)
 
Base::Vector3d toR3 (const gp_Ax2 fromSystem, const Base::Vector3d fromPoint)
 
- Protected Member Functions inherited from TechDraw::DrawViewPart
virtual void addShapes2d (void)
 
virtual TechDraw::GeometryObjectbuildGeometryObject (TopoDS_Shape shape, gp_Ax2 viewAxis)
 
bool checkXDirection (void) const
 
void extractFaces ()
 make faces from the existing edge geometry More...
 
void getRunControl (void)
 
void handleChangedPropertyName (Base::XMLReader &reader, const char *TypeName, const char *PropName) override
 PropertyContainer::handleChangedPropertyName is called during restore to possibly fix reading of older versions of this property container. More...
 
virtual TechDraw::GeometryObjectmakeGeometryForShape (TopoDS_Shape shape)
 
virtual void onChanged (const App::Property *prop) override
 get called by the container when a property was changed More...
 
void partExec (TopoDS_Shape shape)
 
bool prefHardHid (void)
 
bool prefHardViz (void)
 
int prefIsoCount (void)
 
bool prefIsoHid (void)
 
bool prefIsoViz (void)
 
bool prefSeamHid (void)
 
bool prefSeamViz (void)
 
bool prefSmoothHid (void)
 
bool prefSmoothViz (void)
 
virtual void unsetupObject () override
 remove features that are useless without this DVP hatches, geomhatches, dimensions,... More...
 
- Protected Member Functions inherited from TechDraw::DrawView
virtual void validateScale ()
 
int prefScaleType (void)
 
double prefScale (void)
 
- Protected Member Functions inherited from App::DocumentObject
virtual App::DocumentObjectExecReturnexecute (void)
 get called by the document to recompute this feature Normally this method get called in the processing of Document::recompute(). More...
 
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 onChanged (const Property *prop) override
 get called by the container when a property was changed More...
 
virtual void onDocumentRestored ()
 get called after a document has been fully restored 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...
 
virtual App::DocumentObjectExecReturnrecompute (void)
 recompute only this object 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...
 
virtual void handleChangedPropertyType (Base::XMLReader &reader, const char *TypeName, Property *prop)
 PropertyContainer::handleChangedPropertyType is called during restore to possibly fix reading of older versions of the property container. More...
 
virtual void onBeforeChange (const Property *)
 get called before the value is changed More...
 
virtual void onChanged (const Property *)
 get called by the container when a property has changed More...
 
- Protected Member Functions inherited from App::Extension
virtual void extensionOnChanged (const Property *p)
 
void initExtensionType (Base::Type type)
 

Protected Attributes

double m_fudge
 
- Protected Attributes inherited from TechDraw::DrawViewPart
Base::BoundBox3d bbox
 
TechDraw::GeometryObjectgeometryObject
 
bool m_handleFaces
 
std::vector< TechDraw::VertexPtrm_referenceVerts
 
Base::Vector3d m_saveCentroid
 
TopoDS_Shape m_saveShape
 
Base::Vector3d shapeCentroid
 
- 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::SmartPtr 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
 
- Protected Attributes inherited from App::Extension
bool m_isPythonExtension = false
 
Py::SmartPtr ExtensionPythonObject
 

Additional Inherited Members

- 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
 
- 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 ()
 
static Type getClassTypeId ()
 
static void init ()
 
- Static Public Attributes inherited from App::DocumentObject
static DocumentObjectExecReturnStdReturn
 
- 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)
 
- Static Protected Member Functions inherited from App::Extension
static void initExtensionSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Base::Type::instantiationMethod method=nullptr)
 

Constructor & Destructor Documentation

◆ DrawViewDetail()

DrawViewDetail::DrawViewDetail ( void  )

Constructor.

References App::Global, App::Prop_None, and App::Property::ReadOnly.

◆ ~DrawViewDetail()

DrawViewDetail::~DrawViewDetail ( )
virtual

Member Function Documentation

◆ debugDetail()

bool DrawViewDetail::debugDetail ( void  ) const
protected

◆ detailExec()

◆ execute()

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

recalculate the Feature

Reimplemented from TechDraw::DrawViewPart.

References TechDraw::DrawViewPart::addShapes2d(), TechDraw::DrawView::autoScale(), BaseView, TechDraw::DrawView::checkFit(), TechDraw::DrawViewPart::checkXDirection(), Base::Console(), detailExec(), Base::ConsoleSingleton::Error(), TechDraw::DrawView::execute(), TechDraw::DrawViewPart::geometryObject, Base::Persistence::getClassTypeId(), TechDraw::DrawViewSection::getCutShape(), App::DocumentObject::getDocument(), App::DocumentObject::getNameInDocument(), TechDraw::DrawViewPart::getSourceShapeFused(), Base::Persistence::getTypeId(), App::PropertyLink::getValue(), TechDraw::DrawViewPart::getXDirection(), Base::BaseClass::isDerivedFrom(), Base::Type::isDerivedFrom(), App::DocumentObject::isRestoring(), App::PropertyEnumeration::isValue(), TechDraw::DrawView::keepUpdated(), App::Property::purgeTouched(), TechDraw::DrawView::requestPaint(), TechDraw::DrawView::Scale, TechDraw::DrawView::ScaleType, App::PropertyVector::setValue(), App::PropertyFloat::setValue(), App::DocumentObject::StdReturn, App::Document::testStatus(), Base::ConsoleSingleton::Warning(), and TechDraw::DrawViewPart::XDirection.

Referenced by draftobjects.facebinder.Facebinder::addSubobjects(), PathScripts.PathDressupDogbone.ObjectDressup::boneStateList(), ArchSite.Compass::buildCoordinates(), 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().

◆ getDetailRefs()

std::vector< DrawViewDetail * > DrawViewDetail::getDetailRefs ( void  ) const
overridevirtual

Reimplemented from TechDraw::DrawViewPart.

◆ getFudgeRadius()

double DrawViewDetail::getFudgeRadius ( void  )

References App::PropertyFloat::getValue(), m_fudge, and Radius.

Referenced by detailExec().

◆ getParameters()

void DrawViewDetail::getParameters ( void  )
protected

◆ getViewProviderName()

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

returns the type name of the ViewProvider

Reimplemented from TechDraw::DrawViewPart.

◆ mustExecute()

short DrawViewDetail::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::DrawViewPart.

References AnchorPoint, BaseView, App::DocumentObject::isRestoring(), App::Property::isTouched(), TechDraw::DrawView::mustExecute(), Radius, and Reference.

◆ onChanged()

◆ projectEdgesOntoFace()

TopoDS_Shape DrawViewDetail::projectEdgesOntoFace ( TopoDS_Shape  edgeShape,
TopoDS_Face  projFace,
gp_Dir  projDir 
)

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

Referenced by detailExec().

◆ toR3()

Base::Vector3d TechDraw::DrawViewDetail::toR3 ( const gp_Ax2  fromSystem,
const Base::Vector3d  fromPoint 
)
protected

◆ unsetupObject()

void DrawViewDetail::unsetupObject ( void  )
overridevirtual

remove features that are useless without this DVP hatches, geomhatches, dimensions,...

Reimplemented from TechDraw::DrawViewPart.

References BaseView, and App::PropertyLink::getValue().

Member Data Documentation

◆ AnchorPoint

◆ BaseView

◆ m_fudge

double TechDraw::DrawViewDetail::m_fudge
protected

Referenced by getFudgeRadius().

◆ Radius

◆ Reference


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