#include <Mod/TechDraw/App/DrawProjGroup.h>
Detailed Description
Class super-container for managing a collection of DrawProjGroupItem Page Features
Public Member Functions | |
| DrawProjGroup () | |
| Constructor. | |
| Base::BoundBox3d | getBoundingBox () const |
| Anchor Element to align views to. | |
| bool | hasProjection (const char *viewProjType) const |
| Check if container has a view of a specific type. | |
| App::DocumentObject * | addProjection (const char *viewProjType) |
| Adds a projection to the group. More... | |
| int | removeProjection (const char *viewProjType) |
| Removes a projection from the group. More... | |
| virtual const char * | getViewProviderName (void) const override |
| returns the type name of the ViewProvider | |
| App::Enumeration | usedProjectionType (void) |
| Determines either "First Angle" or "Third Angle". | |
methods override Feature | |
| virtual App::DocumentObjectExecReturn * | execute (void) override |
| recalculate the Feature | |
 Public Member Functions inherited from TechDraw::DrawViewCollection | |
| DrawViewCollection () | |
| Constructor. | |
| Public Member Functions inherited from TechDraw::DrawView | |
| DrawView (void) | |
| Constructor. | |
| Public Member Functions inherited from App::DocumentObject | |
| DocumentObject (void) | |
| Constructor. | |
| const char * | getNameInDocument (void) const |
| returns the name which is set in the document for this object (not the name property!) | |
| App::Document * | getDocument (void) const |
| gets the document in which this Object is handled | |
| bool | testIfLinkDAGCompatible (DocumentObject *linkTo) const |
| testIfLinkIsDAG tests a link that is about to be created for circular references. More... | |
| bool | recomputeFeature () |
| Recompute only this feature. | |
| const char * | getStatusString (void) const |
| get the status Message | |
| virtual void | onLostLinkToObject (DocumentObject *) |
| virtual std::vector< PyObject * > | getPySubObjects (const std::vector< std::string > &) const |
| its used to get the python sub objects by name (e.g. by the selection) | |
| void | touch (void) |
| set this document object touched (cause recomputation on dependent features) More... | |
| bool | isTouched (void) const |
| test if this document object is touched | |
| void | enforceRecompute () |
| Enforce this document object to be recomputed. | |
| bool | mustRecompute (void) const |
| Test if this document object must be recomputed. | |
| void | purgeTouched (void) |
| reset this document object touched | |
| bool | isError (void) const |
| set this feature to error | |
| void | purgeError (void) |
| remove the error from the object | |
| bool | isRecomputing () const |
| returns true if this objects is currently recomputing | |
| bool | isRestoring () const |
| returns true if this objects is currently restoring from file | |
| bool | isRemoving () const |
| returns true if this objects is currently removed from the document | |
| unsigned long | getStatus () const |
| return the status bits | |
| std::vector< App::DocumentObject * > | getOutList (void) const |
| returns a list of objects this object is pointing to by Links More... | |
| std::vector< App::DocumentObject * > | getOutListOfProperty (App::Property *) const |
| returns a list of objects linked by the property | |
| std::vector< App::DocumentObject * > | getOutListRecursive (void) const |
| returns a list of objects this object is pointing to by Links and all further descended | |
| std::vector< std::list< App::DocumentObject * > > | getPathsByOutList (App::DocumentObject *to) const |
| get all possible paths from this to another object following the OutList | |
| std::vector< App::DocumentObject * > | getInList (void) const |
| get all objects link to this object | |
| std::vector< App::DocumentObject * > | getInListRecursive (void) const |
| get all objects link directly or indirectly to this object | |
| DocumentObjectGroup * | getGroup () const |
| get group if object is part of a group, otherwise 0 is returned | |
| bool | isInInListRecursive (DocumentObject *objToTest) const |
| test if this object is in the InList and recursive further down | |
| bool | isInInList (DocumentObject *objToTest) const |
| test if this object is directly (non recursive) in the InList | |
| bool | isInOutListRecursive (DocumentObject *objToTest) const |
| test if the given object is in the OutList and recursive further down | |
| bool | isInOutList (DocumentObject *objToTest) const |
| test if this object is directly (non recursive) in the OutList | |
| void | _removeBackLink (DocumentObject *) |
| internal, used by PropertyLink to maintain DAG back links | |
| void | _addBackLink (DocumentObject *) |
| internal, used by PropertyLink to maintain DAG back links | |
| Public Member Functions inherited from App::TransactionalObject | |
| TransactionalObject (void) | |
| Constructor. | |
| Public Member Functions inherited from App::ExtensionContainer | |
| virtual Property * | getPropertyByName (const char *name) const override |
| find a property by its name | |
| virtual const char * | getPropertyName (const Property *prop) const override |
| get the name of a property | |
| virtual void | getPropertyMap (std::map< std::string, Property * > &Map) const override |
| get all properties of the class (including properties of the parent) | |
| virtual void | getPropertyList (std::vector< Property * > &List) const override |
| get all properties of the class (including properties of the parent) | |
| virtual short | getPropertyType (const Property *prop) const override |
| get the Type of a Property | |
| virtual short | getPropertyType (const char *name) const override |
| get the Type of a named Property | |
| virtual const char * | getPropertyGroup (const Property *prop) const override |
| get the Group of a Property | |
| virtual const char * | getPropertyGroup (const char *name) const override |
| get the Group of a named Property | |
| virtual const char * | getPropertyDocumentation (const Property *prop) const override |
| get the Group of a Property | |
| virtual const char * | getPropertyDocumentation (const char *name) const override |
| get the Group of a named Property | |
| Public Member Functions inherited from App::PropertyContainer | |
| PropertyContainer () | |
| virtual | ~PropertyContainer () |
| void | setPropertyStatus (unsigned char bit, bool value) |
| set the Status bit of all properties at once | |
| bool | isReadOnly (const Property *prop) const |
| check if the property is read-only | |
| bool | isReadOnly (const char *name) const |
| check if the named property is read-only | |
| bool | isHidden (const Property *prop) const |
| check if the property is hidden | |
| bool | isHidden (const char *name) const |
| check if the named property is hidden | |
| Public Member Functions inherited from Base::Persistence | |
| virtual void | SaveDocFile (Writer &) const |
| virtual void | RestoreDocFile (Reader &) |
| Public Member Functions inherited from Base::BaseClass | |
| BaseClass () | |
| Construction. | |
| virtual | ~BaseClass () |
| Destruction. | |
Public Attributes | |
| App::PropertyFloat | spacingX |
| Default horizontal spacing between adjacent views on Drawing, in mm. | |
| App::PropertyFloat | spacingY |
| Default vertical spacing between adjacent views on Drawing, in mm. | |
Static Public Attributes | |
| static const char * | ProjectionTypeEnums [] |
| Allowed projection types - either Document, First Angle or Third Angle. | |
Protected Member Functions | |
| bool | checkViewProjType (const char *in) |
| Annoying helper - keep in sync with DrawProjGroupItem::TypeEnums. More... | |
| void | makeViewBbs (DrawProjGroupItem *viewPtrs[10], Base::BoundBox3d bboxes[10], bool documentScale=true) const |
| Populates array of 10 BoundBox3d's given DrawProjGroupItem *s. More... | |
| void | minimumBbViews (DrawProjGroupItem *viewPtrs[10], double &width, double &height) const |
| Helper for calculateAutomaticScale. More... | |
| TechDraw::DrawPage * | getPage (void) const |
| Returns pointer to our page, or NULL if it couldn't be located. | |
| Protected Member Functions inherited from App::DocumentObject | |
| virtual App::DocumentObjectExecReturn * | recompute (void) |
| recompute only this object | |
| virtual void | onBeforeChange (const Property *prop) |
| get called before the value is changed | |
| virtual void | onSettingDocument () |
| get called after setting the document | |
| virtual void | setupObject () |
| get called after a brand new object was created | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Base::Persistence | |
| static std::string | encodeAttribute (const std::string &) |
| Encodes an attribute upon saving. | |
| Protected Attributes inherited from App::DocumentObject | |
| std::bitset< 32 > | StatusBits |
| Py::Object | PythonObject |
| python object of this class and all descendent | |
| App::Document * | _pDoc |
| pointer to the document this object belongs to | |
| std::string | oldLabel |
| Old label; used for renaming expressions. | |
Member Function Documentation
◆ addProjection()
| App::DocumentObject* TechDraw::DrawProjGroup::addProjection | ( | const char * | viewProjType | ) |
Adds a projection to the group.
- Returns
- pointer to the new view
◆ checkViewProjType()
|
protected |
Annoying helper - keep in sync with DrawProjGroupItem::TypeEnums.
- Returns
- true iff 'in' is a valid name for an orthographic/isometric view
◆ makeViewBbs()
|
protected |
Populates array of 10 BoundBox3d's given DrawProjGroupItem *s.
If documentScale is set, then returned bounding boxes are scaled as in the Drawing. Otherwise, the dimensions are as in object space.
◆ minimumBbViews()
|
protected |
Helper for calculateAutomaticScale.
Returns a width and height in object-space scale, for the enabled views without accounting for their actual X and Y positions or borders.
◆ removeProjection()
| int TechDraw::DrawProjGroup::removeProjection | ( | const char * | viewProjType | ) |
Removes a projection from the group.
- Returns
- number of projections remaining
