FreeCAD
List of all members | Public Member Functions | Public Attributes
Part::Circle Class Reference

#include <FeaturePartCircle.h>

Inheritance diagram for Part::Circle:
Inheritance graph
[legend]
Collaboration diagram for Part::Circle:
Collaboration graph
[legend]

Public Member Functions

 Circle ()
 
virtual ~Circle ()
 
- Public Member Functions inherited from Part::Primitive
 Primitive ()
 
virtual ~Primitive ()
 
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...
 
const TopoDS_Shape findOriginOf (const TopoDS_Shape &reference)
 Find the origin of a reference, e.g. More...
 
virtual PyObjectgetPyObject (void)
 This method returns the Python wrapper for a C++ object. More...
 
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) More...
 
virtual ~Feature ()
 
virtual
App::DocumentObjectExecReturn
recompute (void)
 recalculate the feature recompute only this object More...
 
- Public Member Functions inherited from App::GeoFeature
 GeoFeature (void)
 Constructor. More...
 
virtual void transformPlacement (const Base::Placement &transform)
 
virtual ~GeoFeature ()
 
- Public Member Functions inherited from App::DocumentObject
virtual void connectRelabelSignals ()
 
 DocumentObject (void)
 Constructor. More...
 
App::DocumentgetDocument (void) const
 gets the document in which this Object is handled More...
 
virtual const
PropertyExpressionEngine::ExpressionInfo 
getExpression (const ObjectIdentifier &path) const
 
DocumentObjectGroupgetGroup () const
 get group if object is part of a group, otherwise 0 is returned More...
 
std::vector
< App::DocumentObject * > 
getInList (void) const
 get all objects link to this object 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
 
std::vector
< App::DocumentObject * > 
getOutList (void) const
 returns a list of objects this object is pointing to by Links More...
 
const char * getStatusString (void) const
 get the status Message More...
 
virtual void onLostLinkToObject (DocumentObject *)
 Called in case of loosing a link Get called by the document when a object got deleted a link property of this object ist pointing to. More...
 
virtual void renameObjectIdentifiers (const std::map< App::ObjectIdentifier, App::ObjectIdentifier > &paths)
 
virtual void Save (Base::Writer &writer) const
 This method is used to save properties to an XML document. More...
 
virtual void setExpression (const ObjectIdentifier &path, boost::shared_ptr< App::Expression > expr, const char *comment=0)
 
virtual ~DocumentObject ()
 
void touch (void)
 Set the property touched -> changed, cause recomputation in Update() More...
 
bool isTouched (void) const
 test if this feature is touched More...
 
void purgeTouched (void)
 reset this feature touched More...
 
bool isError (void) const
 set this feature to error More...
 
bool isValid (void) const
 
void purgeError (void)
 remove the error from the object More...
 
bool isRecomputing () const
 returns true if this objects is currently recomputing More...
 
bool isRestoring () const
 returns true if this objects is currently restoring from file More...
 
unsigned long getStatus () const
 return the status bits More...
 
bool testStatus (ObjectStatus pos) const
 
void setStatus (ObjectStatus pos, bool on)
 
- Public Member Functions inherited from App::PropertyContainer
virtual void addDynamicProperties (const PropertyContainer *)
 
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)
 
virtual App::PropertygetDynamicPropertyByName (const char *name) 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...
 
virtual PropertygetPropertyByName (const char *name) const
 find a property by its name More...
 
virtual const char * getPropertyDocumentation (const Property *prop) const
 get the Group of a Property More...
 
virtual const char * getPropertyDocumentation (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 const char * getPropertyGroup (const char *name) const
 get the Group of a named 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 short getPropertyType (const Property *prop) const
 get the Type of a Property More...
 
virtual short getPropertyType (const char *name) const
 get the Type of a named Property More...
 
virtual bool isHidden (const Property *prop) const
 check if the property is hidden More...
 
virtual bool isHidden (const char *name) const
 check if the named property is hidden More...
 
virtual bool isReadOnly (const Property *prop) const
 check if the property is read-only More...
 
virtual bool isReadOnly (const char *name) const
 check if the nameed property is read-only More...
 
 PropertyContainer ()
 A constructor. More...
 
virtual bool removeDynamicProperty (const char *name)
 
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
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 with SaveDocFile() saved data. 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...
 
bool isDerivedFrom (const Type type) const
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 

Public Attributes

App::PropertyAngle Angle0
 
App::PropertyAngle Angle1
 
App::PropertyLength Radius
 
- 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
 

methods override feature

App::DocumentObjectExecReturnexecute (void)
 recalculate the Feature More...
 
short mustExecute () const
 mustExecute We call this method to check if the object was modified to be invoked. More...
 
void onChanged (const App::Property *)
 get called by the container when a property was changed More...
 
const char * getViewProviderName (void) const
 returns the type name of the ViewProvider More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Base::Persistence
static void * create (void)
 
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 Part::Primitive
void onChanged (const App::Property *prop)
 get called by the container when a property was changed More...
 
void Restore (Base::XMLReader &reader)
 This method is used to restore properties from an XML document. More...
 
- Protected Member Functions inherited from Part::Feature
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...
 
TopLoc_Location getLocation () const
 
ShapeHistory joinHistory (const ShapeHistory &, const ShapeHistory &)
 
- Protected Member Functions inherited from App::DocumentObject
virtual void onBeforeChange (const Property *prop)
 get called before the value is changed More...
 
virtual void onDocumentRestored ()
 get called after a document has been fully restored More...
 
virtual void onSettingDocument ()
 get called after setting the document More...
 
void resetError (void)
 
void setDocument (App::Document *doc)
 
void setError (void)
 
- Protected Member Functions inherited from App::PropertyContainer
virtual const PropertyDatagetPropertyData (void) const
 
- 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=0)
 
- Protected Attributes inherited from App::DocumentObject
App::Document_pDoc
 pointer to the document this object belongs to More...
 
std::string oldLabel
 Old label; used for renaming expressions. More...
 
boost::BOOST_SIGNALS_NAMESPACE::scoped_connection onRelabledDocumentConnection
 
boost::BOOST_SIGNALS_NAMESPACE::scoped_connection onRelabledObjectConnection
 
const std::string * pcNameInDocument
 
Py::Object PythonObject
 python object of this class and all descendend 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 to mark special stati on the objects. More...
 

Detailed Description

Definition at line 32 of file FeaturePartCircle.h.

Constructor & Destructor Documentation

Circle::Circle ( )

Definition at line 42 of file FeaturePartCircle.cpp.

References ADD_PROPERTY, SCL.SimpleDataTypes::f, and Sketcher::Radius.

Circle::~Circle ( )
virtual

Definition at line 51 of file FeaturePartCircle.cpp.

Member Function Documentation

App::DocumentObjectExecReturn * Circle::execute ( void  )
virtual
const char* Part::Circle::getViewProviderName ( void  ) const
inlinevirtual

returns the type name of the ViewProvider

Reimplemented from Part::Feature.

Definition at line 51 of file FeaturePartCircle.h.

short Circle::mustExecute ( ) const
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 recompution is needed 1: recompution needed -1: the document examine all links of this object and if one is touched -> recompute

Reimplemented from Part::Feature.

Definition at line 55 of file FeaturePartCircle.cpp.

References Angle0, Angle1, App::Property::isTouched(), Part::Feature::mustExecute(), and Radius.

void Circle::onChanged ( const App::Property prop)
virtual

get called by the container when a property was changed

Reimplemented from App::DocumentObject.

Definition at line 77 of file FeaturePartCircle.cpp.

References Angle0, Angle1, App::DocumentObject::isRestoring(), Part::Feature::onChanged(), Radius, and Part::Feature::recompute().

Member Data Documentation

App::PropertyAngle Part::Circle::Angle0

Definition at line 41 of file FeaturePartCircle.h.

Referenced by execute(), mustExecute(), and onChanged().

App::PropertyAngle Part::Circle::Angle1

Definition at line 42 of file FeaturePartCircle.h.

Referenced by execute(), mustExecute(), and onChanged().

App::PropertyLength Part::Circle::Radius

Definition at line 40 of file FeaturePartCircle.h.

Referenced by execute(), mustExecute(), and onChanged().


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