App::PropertyPosition Class Reference
#include <PropertyGeo.h>
Public Member Functions | |
| const char * | getEditorName (void) const |
| Get the class name of the associated property editor item. More... | |
| virtual Base::Unit | getUnit () const |
| PropertyPosition () | |
| A constructor. More... | |
| virtual | ~PropertyPosition () |
| A destructor. More... | |
 Public Member Functions inherited from App::PropertyVector | |
| virtual Property * | Copy (void) const override |
| Returns a new copy of the property (mainly for Undo/Redo and transactions) More... | |
| virtual unsigned int | getMemSize (void) const override |
| 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? This method is defined in Base::Persistence. More... | |
| void | getPaths (std::vector< ObjectIdentifier > &paths) const override |
| Get valid paths for this property; used by auto completer. More... | |
| virtual const boost::any | getPathValue (const ObjectIdentifier &path) const override |
| Get value of property. More... | |
| virtual PyObject * | getPyObject (void) override |
| This method returns the Python wrapper for a C++ object. More... | |
| virtual bool | getPyPathValue (const ObjectIdentifier &path, Py::Object &res) const override |
| Get Python value of property. More... | |
| const Base::Vector3d & | getValue (void) const |
| This method returns a string representation of the property. More... | |
| virtual void | Paste (const Property &from) override |
| Paste the value from the property (mainly for Undo/Redo and transactions) More... | |
| PropertyVector () | |
| A constructor. More... | |
| virtual void | Restore (Base::XMLReader &reader) override |
| This method is used to restore properties from an XML document. More... | |
| virtual void | Save (Base::Writer &writer) const override |
| This method is used to save properties to an XML document. More... | |
| virtual void | setPyObject (PyObject *) override |
| void | setValue (const Base::Vector3d &vec) |
| Sets the property. More... | |
| void | setValue (double x, double y, double z) |
| virtual | ~PropertyVector () |
| A destructor. More... | |
| Public Member Functions inherited from App::Property | |
| virtual void | aboutToSetChildValue (Property &) |
| Called before a child property changing value. More... | |
| virtual void | afterRestore () |
| Called at the beginning of Document::afterRestore() More... | |
| virtual App::ObjectIdentifier | canonicalPath (const App::ObjectIdentifier &p) const |
| Convert p to a canonical representation of it. More... | |
| PropertyContainer * | getContainer (void) const |
| Get a pointer to the PropertyContainer derived class the property belongs to. More... | |
| const char * | getDocumentation (void) const |
| Get the documentation of this property. More... | |
| std::string | getFullName () const |
| const char * | getGroup (void) const |
| Get the group of this property. More... | |
| const char * | getName (void) const |
| get the name of this property in the belonging container More... | |
| unsigned long | getStatus () const |
| return the status bits More... | |
| short | getType (void) const |
| Get the type of the property in the container. More... | |
| virtual void | hasSetChildValue (Property &) |
| Called when a child property has changed value. More... | |
| bool | isReadOnly () const |
| bool | isSinglePrecision () const |
| Gets precision of properties using floating point numbers. More... | |
| bool | isTouched (void) const |
| Test if this property is touched. More... | |
| virtual void | onContainerRestored () |
| Called before calling DocumentObject::onDocumentRestored() More... | |
| Property () | |
| void | purgeTouched (void) |
| Reset this property touched. More... | |
| void | setContainer (PropertyContainer *Father) |
| Is called by the framework to set the father (container) More... | |
| virtual void | setPathValue (const App::ObjectIdentifier &path, const boost::any &value) |
| Set value of property. More... | |
| void | setReadOnly (bool readOnly) |
| Sets property editable/grayed out in property editor. More... | |
| void | setSinglePrecision (bool single) |
| Sets precision of properties using floating point numbers to single, the default is double. More... | |
| void | setStatus (Status pos, bool on) |
| void | setStatusValue (unsigned long status) |
| bool | testStatus (Status pos) const |
| void | touch () |
| Property status handling. More... | |
| virtual | ~Property () |
| Public Member Functions inherited from Base::Persistence | |
| void | dumpToStream (std::ostream &stream, int compression) |
| virtual Base::Type | getTypeId (void) const |
| virtual void | RestoreDocFile (Reader &) |
| This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More... | |
| void | restoreFromStream (std::istream &stream) |
| virtual void | SaveDocFile (Writer &) const |
| This method is used to save large amounts of data to a binary file. More... | |
| Public Member Functions inherited from Base::BaseClass | |
| BaseClass () | |
| Construction. More... | |
| bool | isDerivedFrom (const Type type) const |
| virtual | ~BaseClass () |
| Destruction. More... | |
Additional Inherited Members | |
| Public Types inherited from App::Property | |
| enum | Status { Touched = 0, Immutable = 1, ReadOnly = 2, Hidden = 3, Transient = 4, MaterialEdit = 5, NoMaterialListEdit = 6, Output = 7, LockDynamic = 8, NoModify = 9, PartialTrigger = 10, NoRecompute = 11, Single = 12, Ordered = 13, EvalOnRestore = 14, PropStaticBegin = 21, PropDynamic = 21, PropNoPersist = 22, PropNoRecompute = 23, PropReadOnly = 24, PropTransient = 25, PropHidden = 26, PropOutput = 27, PropStaticEnd = 28, User1 = 28, User2 = 29, User3 = 30, User4 = 31 } |
| Static Public Member Functions inherited from App::Property | |
| static void | destroy (Property *p) |
| For safe deleting of a dynamic property. More... | |
| Static Public Member Functions inherited from Base::Persistence | |
| static void * | create (void) |
| static std::string | encodeAttribute (const std::string &) |
| Encodes an attribute upon saving. More... | |
| static Base::Type | getClassTypeId (void) |
| static void | init (void) |
| Static Public Member Functions inherited from Base::BaseClass | |
| static void * | create (void) |
| static Type | getClassTypeId (void) |
| static void | init (void) |
| Protected Member Functions inherited from App::Property | |
| virtual void | aboutToSetValue (void) |
| Gets called by all setValue() methods before the value has changed. More... | |
| virtual void | hasSetValue (void) |
| Gets called by all setValue() methods after the value has changed. More... | |
| virtual void | verifyPath (const App::ObjectIdentifier &p) const |
| Verify a path for the current property. More... | |
| 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 App::Property | |
| std::bitset< 32 > | StatusBits |
| Status bits of the property 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... | |
Constructor & Destructor Documentation
◆ PropertyPosition()
| PropertyPosition::PropertyPosition | ( | ) |
A constructor.
A more elaborate description of the constructor.
◆ ~PropertyPosition()
|
virtual |
A destructor.
A more elaborate description of the destructor.
Member Function Documentation
◆ getEditorName()
|
virtual |
Get the class name of the associated property editor item.
Reimplemented from App::PropertyVector.
◆ getUnit()
|
virtual |
Reimplemented from App::PropertyVector.
References Base::Unit::Length.
The documentation for this class was generated from the following files:
- src/App/PropertyGeo.h
- src/App/PropertyGeo.cpp
