PartDesign::Revolution Class Reference
#include <FeatureRevolution.h>
Public Member Functions | |
| Revolution () | |
 Public Member Functions inherited from PartDesign::ProfileBased | |
| virtual Part::Feature * | getBaseObject (bool silent=false) const |
| Returns the BaseFeature property's object (if any) More... | |
| Base::Vector3d | getProfileNormal () const |
| Part::TopoShape | getProfileShape () const |
| std::vector< TopoDS_Wire > | getProfileWires () const |
| Returns the wires the sketch is composed of. More... | |
| int | getSketchAxisCount (void) const |
| retrieves the number of axes in the linked sketch (defined as construction lines) More... | |
| const TopoDS_Face | getSupportFace () const |
| Returns the face of the sketch support (if any) More... | |
| double | getThroughAllLength () const |
| TopoDS_Shape | getVerifiedFace (bool silent=false) const |
| Verifies the linked Object and returns the shape used as profile. More... | |
| Part::Feature * | getVerifiedObject (bool silent=false) const |
| Verifies the linked Profile and returns it if it is a valid object. More... | |
| Part::Part2DObject * | getVerifiedSketch (bool silent=false) const |
| Verifies the linked Profile and returns it if it is a valid 2D object. More... | |
| 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... | |
| short | mustExecute () const |
| mustExecute We call this method to check if the object was modified to be invoked. More... | |
| void | positionByPrevious (void) |
| calculates and updates the Placement property based on the features this one is made from: either from Base, if there is one, or from sketch, if there is no base. More... | |
| ProfileBased () | |
| virtual void | Restore (Base::XMLReader &reader) |
| This method is used to restore properties from an XML document. More... | |
| void | setupObject () |
| get called after a brand new object was created More... | |
| virtual void | transformPlacement (const Base::Placement &transform) |
| applies a transform on the Placement of the Sketch or its support if it has one More... | |
| Public Member Functions inherited from PartDesign::FeatureAddSub | |
| FeatureAddSub () | |
| virtual void | getAddSubShape (Part::TopoShape &addShape, Part::TopoShape &subShape) |
| Type | getAddSubType () |
| virtual short | mustExecute () const override |
| mustExecute We call this method to check if the object was modified to be invoked. More... | |
| Public Member Functions inherited from PartDesign::Feature | |
| Feature () | |
| virtual Part::Feature * | getBaseObject (bool silent=false) const |
| Returns the BaseFeature property's object (if any) More... | |
| virtual const TopoDS_Shape & | getBaseShape () const |
| Returns the BaseFeature property's shape (if any) More... | |
| Part::TopoShape | getBaseTopoShape (bool silent=false) const |
| Returns the BaseFeature property's TopoShape (if any) More... | |
| Body * | getFeatureBody () const |
| Returns the body the feature is in, or none. More... | |
| virtual PyObject * | getPyObject (void) |
| getPyObject returns the Python binding object More... | |
| virtual const char * | getViewProviderName () const |
| returns the type name of the ViewProvider More... | |
| short | mustExecute () const |
| mustExecute We call this method to check if the object was modified to be invoked. More... | |
| Public Member Functions inherited from Part::Feature | |
| Feature (void) | |
| Constructor. More... | |
| virtual | ~Feature () |
| virtual const App::PropertyComplexGeoData * | getPropertyOfGeometry () const override |
| This method returns the main property of a geometric object that holds the actual geometry. More... | |
| TopLoc_Location | getLocation () const |
| virtual DocumentObject * | getSubObject (const char *subname, PyObject **pyObj, Base::Matrix4D *mat, bool transform, int depth) const override |
| Get the sub element/object by name. More... | |
| Public Member Functions inherited from App::GeoFeature | |
| GeoFeature (void) | |
| Constructor. More... | |
| virtual std::pair< std::string, std::string > | getElementName (const char *name, ElementNameType type=Normal) const |
| Return the new and old style sub-element name. More... | |
| virtual const PropertyComplexGeoData * | getPropertyOfGeometry () const |
| This method returns the main property of a geometric object that holds the actual geometry. More... | |
| virtual PyObject * | getPyObject (void) |
| getPyObject returns the Python binding object More... | |
| Base::Placement | globalPlacement () const |
| Calculates the placement in the global reference coordinate system. More... | |
| virtual void | transformPlacement (const Base::Placement &transform) |
| transformPlacement applies transform to placement of this shape. More... | |
| virtual | ~GeoFeature () |
| Public Member Functions inherited from App::DocumentObject | |
| virtual App::Property * | addDynamicProperty (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::Document * | getDocument (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... | |
| DocumentObjectGroup * | getGroup () 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 DocumentObject * | getLinkedObject (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 PyObject * | getPyObject (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 DocumentObject * | getSubObject (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::DocumentObject * | resolve (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::DocumentObject * | resolveRelativeLink (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::Extension * | getExtension (Base::Type, bool derived=true, bool no_except=false) const |
| App::Extension * | getExtension (const std::string &name) const |
| template<typename ExtensionT > | |
| ExtensionT * | getExtensionByType (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 Property * | getPropertyByName (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::Property * | addDynamicProperty (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::Property * | getDynamicPropertyByName (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 Property * | getPropertyByName (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 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... | |
Public Attributes | |
| App::PropertyAngle | Angle |
| App::PropertyVector | Axis |
| App::PropertyVector | Base |
| App::PropertyLinkSub | ReferenceAxis |
| if this property is set to a valid link, both Axis and Base properties are calculated according to the linked line More... | |
| Public Attributes inherited from PartDesign::ProfileBased | |
| App::PropertyBool | AllowMultiFace |
| App::PropertyBool | Midplane |
| Make extrusion symmetric to sketch plane. More... | |
| App::PropertyLinkSub | Profile |
| Profile used to create this feature. More... | |
| App::PropertyBool | Reversed |
| Reverse extrusion direction. More... | |
| App::PropertyLinkSub | UpToFace |
| Face to extrude up to. More... | |
| Public Attributes inherited from PartDesign::FeatureAddSub | |
| Part::PropertyPartShape | AddSubShape |
| App::PropertyBool | Refine |
| Public Attributes inherited from PartDesign::Feature | |
| App::PropertyLink | BaseFeature |
| Base feature which this feature will be fused into or cut out of. More... | |
| Public Attributes inherited from Part::Feature | |
| PropertyPartShape | Shape |
| Public Attributes inherited from App::GeoFeature | |
| PropertyPlacement | Placement |
| 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 | |
| static const App::PropertyAngle::Constraints | floatAngle = { Base::toDegrees<double>(Precision::Angular()), 360.0, 1.0 } |
| App::DocumentObjectExecReturn * | execute (void) |
| Recalculate the feature Revolves the Sketch around the given Axis (with basepoint Base) The angle of the revolution is given by Angle. More... | |
| short | mustExecute () const |
| mustExecute We call this method to check if the object was modified to be invoked. More... | |
| const char * | getViewProviderName (void) const |
| returns the type name of the view provider More... | |
| bool | suggestReversed (void) |
| suggests a value for Reversed flag so that material is always added to the support More... | |
| void | updateAxis (void) |
| updates Axis from ReferenceAxis More... | |
Additional Inherited Members | |
| Public Types inherited from PartDesign::ProfileBased | |
| enum class | ForbiddenAxis { NoCheck = 0 , NotPerpendicularWithNormal = 1 , NotParallelWithNormal = 2 } |
| Public Types inherited from PartDesign::FeatureAddSub | |
| enum | Type { Additive = 0 , Subtractive } |
| Public Types inherited from App::GeoFeature | |
| enum | ElementNameType { Normal =0 , Import =1 , Export =2 } |
| Specify the type of element name to return when calling getElementName() More... | |
| 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 PartDesign::Feature | |
| static bool | isDatum (const App::DocumentObject *feature) |
| Check whether the given feature is a datum feature. More... | |
| Static Public Member Functions inherited from Part::Feature | |
| static TopoDS_Shape | getShape (const App::DocumentObject *obj, const char *subname=nullptr, bool needSubElement=false, Base::Matrix4D *pmat=nullptr, App::DocumentObject **owner=nullptr, bool resolveLink=true, bool transform=true) |
| Convenience function to extract shape from fully qualified subname. More... | |
| static TopoShape | getTopoShape (const App::DocumentObject *obj, const char *subname=nullptr, bool needSubElement=false, Base::Matrix4D *pmat=nullptr, App::DocumentObject **owner=nullptr, bool resolveLink=true, bool transform=true, bool noElementMap=false) |
| static void | clearShapeCache () |
| static App::DocumentObject * | getShapeOwner (const App::DocumentObject *obj, const char *subname=nullptr) |
| static bool | hasShapeOwner (const App::DocumentObject *obj, const char *subname=nullptr) |
| Static Public Member Functions inherited from App::GeoFeature | |
| static DocumentObject * | resolveElement (App::DocumentObject *obj, const char *subname, std::pair< std::string, std::string > &elementName, bool append=false, ElementNameType type=Normal, const DocumentObject *filter=nullptr, const char **element=nullptr, GeoFeature **geo=nullptr) |
| Resolve both the new and old style element name. More... | |
| 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 DocumentObjectExecReturn * | StdReturn |
| Protected Member Functions inherited from PartDesign::ProfileBased | |
| void | getAxis (const App::DocumentObject *pcReferenceAxis, const std::vector< std::string > &subReferenceAxis, Base::Vector3d &base, Base::Vector3d &dir, ForbiddenAxis checkAxis) const |
| get Axis from ReferenceAxis More... | |
| double | getReversedAngle (const Base::Vector3d &b, const Base::Vector3d &v) const |
| Used to suggest a value for Reversed flag so that material is always removed (Groove) or added (Revolution) from the support. More... | |
| void | onChanged (const App::Property *prop) |
| get called by the container when a property was changed More... | |
| void | remapSupportShape (const TopoDS_Shape &) |
| Protected Member Functions inherited from PartDesign::FeatureAddSub | |
| TopoDS_Shape | refineShapeIfActive (const TopoDS_Shape &) const |
| Protected Member Functions inherited from Part::Feature | |
| virtual App::DocumentObjectExecReturn * | recompute () override |
| recompute only this object More... | |
| ShapeHistory | buildHistory (BRepBuilderAPI_MakeShape &, TopAbs_ShapeEnum type, const TopoDS_Shape &newS, const TopoDS_Shape &oldS) |
| Build a history of changes MakeShape: The operation that created the changes, e.g. More... | |
| ShapeHistory | joinHistory (const ShapeHistory &, const ShapeHistory &) |
| Protected Member Functions inherited from App::DocumentObject | |
| virtual App::DocumentObjectExecReturn * | execute (void) |
| get called by the document to recompute this feature Normally this method get called in the processing of Document::recompute(). More... | |
| App::DocumentObjectExecReturn * | executeExtensions () |
| 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::DocumentObjectExecReturn * | recompute (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 PropertyData & | getPropertyData (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... | |
| Static Protected Member Functions inherited from PartDesign::ProfileBased | |
| static void | addOffsetToFace (TopoDS_Face &upToFace, const gp_Dir &dir, double offset) |
| Add an offset to the face. More... | |
| static bool | checkLineCrossesFace (const gp_Lin &line, const TopoDS_Face &face) |
| Check whether the line crosses the face (line and face must be on the same plane) More... | |
| static bool | checkWireInsideFace (const TopoDS_Wire &wire, const TopoDS_Face &face, const gp_Dir &dir) |
| Check whether the wire after projection on the face is inside the face. More... | |
| static void | getUpToFace (TopoDS_Face &upToFace, const TopoDS_Shape &support, const TopoDS_Face &supportface, const TopoDS_Shape &sketchshape, const std::string &method, const gp_Dir &dir) |
| Find a valid face to extrude up to. More... | |
| static void | getUpToFaceFromLinkSub (TopoDS_Face &upToFace, const App::PropertyLinkSub &refFace) |
| Extract a face from a given LinkSub. More... | |
| Static Protected Member Functions inherited from PartDesign::Feature | |
| static int | countSolids (const TopoDS_Shape &, TopAbs_ShapeEnum type=TopAbs_SOLID) |
| static const gp_Pnt | getPointFromFace (const TopoDS_Face &f) |
| Grab any point from the given face. More... | |
| static TopoDS_Shape | getSolid (const TopoDS_Shape &) |
| Get a solid of the given shape. More... | |
| static gp_Pln | makePlnFromPlane (const App::DocumentObject *obj) |
| Make a shape from a base plane (convenience method) More... | |
| static TopoDS_Shape | makeShapeFromPlane (const App::DocumentObject *obj) |
| Static Protected Member Functions inherited from App::PropertyContainer | |
| static const PropertyData * | getPropertyDataPtr (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 PartDesign::FeatureAddSub | |
| Type | addSubType |
| 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 |
Constructor & Destructor Documentation
◆ Revolution()
| PartDesign::Revolution::Revolution | ( | ) |
Member Function Documentation
◆ execute()
|
virtual |
Recalculate the feature Revolves the Sketch around the given Axis (with basepoint Base) The angle of the revolution is given by Angle.
If Midplane is true, then the revolution will extend for half of Angle on both sides of the sketch plane. If Reversed is true then the direction of revolution will be reversed. The created material will be fused with the sketch support (if there is one)
Reimplemented from Part::Feature.
References PartDesign::FeatureAddSub::AddSubShape, Angle, Axis, PartDesign::ProfileBased::checkLineCrossesFace(), PartDesign::Feature::getBaseShape(), Part::Feature::getLocation(), PartDesign::Feature::getSolid(), App::PropertyVector::getValue(), App::PropertyBool::getValue(), App::PropertyQuantity::getValue(), PartDesign::ProfileBased::getVerifiedFace(), PartDesign::ProfileBased::Midplane, PartDesign::ProfileBased::positionByPrevious(), PartDesign::FeatureAddSub::refineShapeIfActive(), PartDesign::ProfileBased::Reversed, Part::PropertyPartShape::setValue(), Part::Feature::Shape, App::DocumentObject::StdReturn, and updateAxis().
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().
◆ getViewProviderName()
|
virtual |
returns the type name of the view provider
Reimplemented from PartDesign::Feature.
◆ mustExecute()
|
virtual |
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 PartDesign::FeatureAddSub.
References Angle, Axis, App::Property::isTouched(), PartDesign::ProfileBased::mustExecute(), App::GeoFeature::Placement, and ReferenceAxis.
◆ suggestReversed()
| bool PartDesign::Revolution::suggestReversed | ( | void | ) |
suggests a value for Reversed flag so that material is always added to the support
References Axis, PartDesign::ProfileBased::getReversedAngle(), App::PropertyVector::getValue(), and updateAxis().
◆ updateAxis()
|
protected |
updates Axis from ReferenceAxis
References Axis, PartDesign::ProfileBased::getAxis(), App::PropertyLinkSub::getSubValues(), App::PropertyLinkSub::getValue(), PartDesign::ProfileBased::NotParallelWithNormal, ReferenceAxis, App::PropertyVector::setValue(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.
Referenced by execute(), and suggestReversed().
Member Data Documentation
◆ Angle
| App::PropertyAngle PartDesign::Revolution::Angle |
◆ Axis
| App::PropertyVector PartDesign::Revolution::Axis |
Referenced by execute(), mustExecute(), Revolution(), suggestReversed(), and updateAxis().
◆ Base
| App::PropertyVector PartDesign::Revolution::Base |
◆ floatAngle
|
staticprotected |
Referenced by Revolution().
◆ ReferenceAxis
| App::PropertyLinkSub PartDesign::Revolution::ReferenceAxis |
if this property is set to a valid link, both Axis and Base properties are calculated according to the linked line
Referenced by mustExecute(), Revolution(), PartDesignGui::TaskRevolutionParameters::TaskRevolutionParameters(), and updateAxis().
The documentation for this class was generated from the following files:
- FreeCAD/src/Mod/PartDesign/App/FeatureRevolution.h
- FreeCAD/src/Mod/PartDesign/App/FeatureRevolution.cpp
