Base class of all properties This is the father of all properties. More...

#include <Property.h>

Public Types

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
}
 

Public Member Functions

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...
 
virtual PropertyCopy (void) const =0
 Returns a new copy of the property (mainly for Undo/Redo and transactions) More...
 
PropertyContainergetContainer (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...
 
virtual const char * getEditorName (void) const
 Get the class name of the associated property editor item. More...
 
std::string getFullName () const
 
const char * getGroup (void) const
 Get the group of this property. 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...
 
const char * getName (void) const
 get the name of this property in the belonging container More...
 
virtual void getPaths (std::vector< App::ObjectIdentifier > &paths) const
 Get valid paths for this property; used by auto completer. More...
 
virtual const boost::any getPathValue (const App::ObjectIdentifier &path) const
 Get value of property. More...
 
virtual bool getPyPathValue (const App::ObjectIdentifier &, Py::Object &) const
 Get Python value of property. 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...
 
virtual void Paste (const Property &from)=0
 Paste the value from the property (mainly for Undo/Redo and transactions) 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 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...
 
virtual PyObjectgetPyObject (void)
 This method returns the Python wrapper for a C++ object. More...
 
bool isDerivedFrom (const Type type) const
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 

Static Public Member Functions

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

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...
 

Protected Attributes

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...
 

Friends

class DynamicProperty
 
class PropertyContainer
 
struct PropertyData
 

Additional Inherited Members

- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
 

Detailed Description

Base class of all properties This is the father of all properties.

Properties are objects which are used in the document tree to parametrize e.g. features and their graphical output. They are also used to gain access from the scripting facility. /par This abstract base class defines all methods shared by all possible properties. It is also possible to define user properties and use them in the framework...

Member Enumeration Documentation

◆ Status

Enumerator
Touched 
Immutable 
ReadOnly 
Hidden 
Transient 
MaterialEdit 
NoMaterialListEdit 
Output 
LockDynamic 
NoModify 
PartialTrigger 
NoRecompute 
Single 
Ordered 
EvalOnRestore 
PropStaticBegin 
PropDynamic 
PropNoPersist 
PropNoRecompute 
PropReadOnly 
PropTransient 
PropHidden 
PropOutput 
PropStaticEnd 
User1 
User2 
User3 
User4 

Constructor & Destructor Documentation

◆ Property()

Property::Property ( )

◆ ~Property()

Property::~Property ( )
virtual

Member Function Documentation

◆ aboutToSetChildValue()

virtual void App::Property::aboutToSetChildValue ( Property )
virtual

Called before a child property changing value.

Reimplemented in App::PropertyXLinkSubList, and App::PropertyXLinkContainer.

Referenced by App::PropertyXLink::aboutToSetValue().

◆ aboutToSetValue()

void Property::aboutToSetValue ( void  )
protectedvirtual

Gets called by all setValue() methods before the value has changed.

Reimplemented in App::PropertyFileIncluded, and App::PropertyXLink.

References App::PropertyContainer::onBeforeChange().

Referenced by App::PropertyXLinkSubList::aboutToSetChildValue(), App::PropertyXLink::aboutToSetValue(), App::PropertyFileIncluded::aboutToSetValue(), App::PropertyXLinkContainer::breakLink(), Fem::PropertyFemMesh::Paste(), Fem::PropertyPostDataObject::Paste(), Mesh::PropertyNormalList::Paste(), Mesh::PropertyCurvatureList::Paste(), Mesh::PropertyMeshKernel::Paste(), Part::PropertyPartShape::Paste(), Path::PropertyPath::Paste(), Path::PropertyTool::Paste(), Path::PropertyTooltable::Paste(), Points::PropertyPointKernel::Paste(), Robot::PropertyTrajectory::Paste(), App::PropertyPythonObject::Paste(), Inspection::PropertyDistanceList::Paste(), Part::PropertyShapeHistory::Paste(), Part::PropertyFilletEdges::Paste(), App::PropertyXLinkSubList::Paste(), App::PropertyPythonObject::Restore(), Mesh::PropertyMeshKernel::Restore(), Points::PropertyPointKernel::Restore(), App::PropertyPythonObject::RestoreDocFile(), Fem::PropertyFemMesh::RestoreDocFile(), Fem::PropertyPostDataObject::RestoreDocFile(), Mesh::PropertyMeshKernel::RestoreDocFile(), Path::PropertyPath::RestoreDocFile(), Points::PropertyPointKernel::RestoreDocFile(), Mesh::PropertyMeshKernel::setPointIndices(), App::PropertyPythonObject::setPyObject(), App::PropertyLink::setValue(), App::PropertyLinkSub::setValue(), Mesh::PropertyNormalList::setValue(), Mesh::PropertyCurvatureList::setValue(), Fem::PropertyFemMesh::setValue(), Mesh::PropertyMeshKernel::setValue(), Points::PropertyPointKernel::setValue(), Part::PropertyShapeHistory::setValue(), Path::PropertyTool::setValue(), Path::PropertyPath::setValue(), Path::PropertyTooltable::setValue(), Part::PropertyPartShape::setValue(), Robot::PropertyTrajectory::setValue(), Fem::PropertyPostDataObject::setValue(), App::PropertyLinkSubList::setValue(), Inspection::PropertyDistanceList::setValue(), Spreadsheet::PropertyColumnWidths::setValue(), Part::PropertyFilletEdges::setValue(), Spreadsheet::PropertyRowHeights::setValue(), App::PropertyPythonObject::setValue(), Fem::PropertyFemMesh::setValuePtr(), Mesh::PropertyMeshKernel::setValuePtr(), Spreadsheet::PropertyColumnWidths::setValues(), Spreadsheet::PropertyRowHeights::setValues(), Mesh::PropertyNormalList::setValues(), Mesh::PropertyCurvatureList::setValues(), App::PropertyLinkSubList::setValues(), Part::PropertyFilletEdges::setValues(), Inspection::PropertyDistanceList::setValues(), Part::PropertyShapeHistory::setValues(), Mesh::PropertyMeshKernel::startEditing(), Points::PropertyPointKernel::startEditing(), Mesh::PropertyMeshKernel::swapMesh(), Fem::PropertyFemMesh::transformGeometry(), Mesh::PropertyNormalList::transformGeometry(), Mesh::PropertyCurvatureList::transformGeometry(), Mesh::PropertyMeshKernel::transformGeometry(), Part::PropertyPartShape::transformGeometry(), and Points::PropertyPointKernel::transformGeometry().

◆ afterRestore()

virtual void App::Property::afterRestore ( )
virtual

Called at the beginning of Document::afterRestore()

This function is called without dependency sorting, because some types of link property can only reconstructs the linking information inside this function.

One example use case of this function is PropertyLinkSub that uses afterRestore() to parse and restore subname references, which may contain sub-object reference from external document, and there will be special mapping required during object import.

Another example is PropertyExpressionEngine which only parse the restored expression in afterRestore(). The reason, in addition to subname mapping like PropertyLinkSub, is that it can handle document name adjustment as well. It internally relies on PropertyXLink to store the external document path for external linking. When the external document is restored, its internal name may change due to name conflict with existing documents. PropertyExpressionEngine can now auto adjust external references without any problem.

Reimplemented in Spreadsheet::PropertySheet, App::PropertyXLinkContainer, App::PropertyXLinkSubList, App::PropertyXLink, App::PropertyLinkSubList, App::PropertyLinkSub, and App::PropertyExpressionEngine.

◆ canonicalPath()

ObjectIdentifier Property::canonicalPath ( const App::ObjectIdentifier p) const
virtual

Convert p to a canonical representation of it.

Reimplemented in Sketcher::PropertyConstraintList, and App::PropertyExpressionEngine.

Referenced by Gui::ExpressionBinding::bind().

◆ Copy()

Property * Property::Copy ( void  ) const
pure virtual

Returns a new copy of the property (mainly for Undo/Redo and transactions)

Implemented in Spreadsheet::PropertySheet, Sketcher::PropertyConstraintList, App::PropertyPersistentObject, App::PropertyMaterialList, App::PropertyColorList, App::PropertyBoolList, App::PropertyStringList, App::PropertyFloatList, App::PropertyIntegerList, App::PropertyXLinkSubList, App::PropertyXLink, App::PropertyLinkSubList, App::PropertyLinkSub, App::PropertyLinkList, App::PropertyLink, App::PropertyPlacementList, App::PropertyPlacement, App::PropertyVectorList, App::PropertyVector, App::PropertyExpressionEngine, TechDraw::PropertyGeomFormatList, TechDraw::PropertyCosmeticVertexList, TechDraw::PropertyCosmeticEdgeList, TechDraw::PropertyCenterLineList, Spreadsheet::PropertySpreadsheetQuantity, Spreadsheet::PropertyRowHeights, Spreadsheet::PropertyColumnWidths, Robot::PropertyTrajectory, Points::PropertyPointKernel, Points::PropertyCurvatureList, Points::PropertyNormalList, Points::PropertyGreyValueList, Path::PropertyTooltable, Path::PropertyTool, Path::PropertyPath, Part::PropertyFilletEdges, Part::PropertyShapeHistory, Part::PropertyPartShape, Part::PropertyGeometryList, Mesh::PropertyMeshKernel, Mesh::PropertyCurvatureList, Mesh::PropertyNormalList, Inspection::PropertyDistanceList, Fem::PropertyPostDataObject, Fem::PropertyFemMesh, App::PropertyMaterial, App::PropertyColor, App::PropertyBool, App::PropertyUUID, App::PropertyString, App::PropertyFloat, App::PropertyMap, App::PropertyIntegerSet, App::PropertyEnumeration, App::PropertyPath, App::PropertyInteger, App::PropertyPythonObject, App::PropertyPlacementLink, App::PropertyMatrix, and App::PropertyFileIncluded.

Referenced by App::TransactionObject::addOrRemoveProperty(), PartGui::ViewProviderCustom::onChanged(), SketcherGui::ViewProviderCustom::onChanged(), and App::TransactionObject::setProperty().

◆ destroy()

void Property::destroy ( Property p)
static

For safe deleting of a dynamic property.

References App::PropertyCleaner::add().

Referenced by App::DynamicProperty::removeDynamicProperty().

◆ getContainer()

PropertyContainer* App::Property::getContainer ( void  ) const

Get a pointer to the PropertyContainer derived class the property belongs to.

Referenced by App::TransactionObject::addOrRemoveProperty(), Gui::PropertyEditor::PropertyEditor::appendProperty(), App::PropertyLink::breakLink(), App::PropertyLinkList::breakLink(), App::PropertyLinkSub::breakLink(), App::PropertyLinkSubList::breakLink(), App::PropertyXLinkSubList::breakLink(), App::PropertyXLinkContainer::breakLink(), App::PropertyExpressionEngine::canonicalPath(), App::PropertyXLinkContainer::clearDeps(), App::PropertyLinkSub::CopyOnImportExternal(), App::PropertyLinkSubList::CopyOnImportExternal(), App::PropertyXLink::CopyOnImportExternal(), App::PropertyLinkSub::CopyOnLabelChange(), App::PropertyLinkSubList::CopyOnLabelChange(), App::PropertyXLink::CopyOnLabelChange(), App::PropertyLink::CopyOnLinkReplace(), App::PropertyLinkList::CopyOnLinkReplace(), App::PropertyLinkSub::CopyOnLinkReplace(), App::PropertyLinkSubList::CopyOnLinkReplace(), App::PropertyXLink::CopyOnLinkReplace(), App::PropertyExpressionEngine::execute(), getPaths(), Part::PropertyPartShape::getPaths(), App::PropertyContainerPy::getPropertyByName(), App::PropertyLinkBase::hasSetValue(), Spreadsheet::PropertySheet::insertColumns(), Spreadsheet::PropertySheet::insertRows(), App::GeoFeatureGroupExtension::isLinkValid(), App::ObjectIdentifier::ObjectIdentifier(), PartGui::ViewProviderPartExt::onChanged(), PartGui::PropertyEnumAttacherItem::openTask(), App::DocumentObjectT::operator=(), Spreadsheet::PropertySheet::removeColumns(), Spreadsheet::PropertySheet::removeRows(), App::PropertyLink::resetLink(), App::PropertyLink::Restore(), App::PropertyLinkList::Restore(), App::PropertyLinkSub::Restore(), App::PropertyLinkSubList::Restore(), App::PropertyXLink::Restore(), Fem::PropertyPostDataObject::RestoreDocFile(), Part::PropertyPartShape::RestoreDocFile(), Path::PropertyPath::RestoreDocFile(), App::PropertyXLink::restoreLink(), App::PropertyLinkSub::Save(), App::PropertyLinkSubList::Save(), App::PropertyXLink::Save(), App::PropertyXLinkContainer::Save(), Fem::PropertyPostDataObject::SaveDocFile(), Part::PropertyPartShape::SaveDocFile(), App::PropertyLinkList::set1Value(), Spreadsheet::Cell::setAlias(), App::PropertyXLink::setAllowPartial(), App::TransactionObject::setProperty(), App::LinkBaseExtension::setProperty(), App::PropertyLinkList::setSize(), App::PropertyLink::setValue(), App::PropertyXLink::setValue(), App::PropertyLinkSub::setValue(), App::PropertyLinkSubList::setValue(), App::PropertyLinkList::setValues(), App::PropertyLinkSubList::setValues(), Gui::RecoveryWriter::shouldWrite(), App::PropertyXLinkContainer::updateDeps(), Spreadsheet::PropertySheet::updateElementReference(), App::PropertyLinkSubList::updateElementReference(), App::PropertyXLinkSubList::upgrade(), App::PropertyXLinkSub::upgrade(), App::PropertyLinkList::~PropertyLinkList(), App::PropertyLinkSub::~PropertyLinkSub(), and App::PropertyLinkSubList::~PropertyLinkSubList().

◆ getDocumentation()

const char * Property::getDocumentation ( void  ) const

◆ getEditorName()

◆ getFullName()

◆ getGroup()

◆ getMemSize()

virtual unsigned int App::Property::getMemSize ( void  ) const
overridevirtual

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.

See also
Base::Persistence

Implements Base::Persistence.

Reimplemented in Spreadsheet::PropertySheet, Sketcher::PropertyConstraintList, App::PropertyPersistentObject, App::PropertyMaterialList, App::PropertyColorList, App::PropertyBoolList, App::PropertyStringList, App::PropertyFloatList, App::PropertyIntegerList, App::PropertyXLinkSubList, App::PropertyLinkSubList, App::PropertyLinkSub, App::PropertyLinkList, App::PropertyLink, App::PropertyPlacementList, App::PropertyPlacement, App::PropertyVectorList, App::PropertyVector, App::PropertyExpressionEngine, TechDraw::PropertyGeomFormatList, TechDraw::PropertyCosmeticVertexList, TechDraw::PropertyCosmeticEdgeList, TechDraw::PropertyCenterLineList, Robot::PropertyTrajectory, Points::PropertyPointKernel, Points::PropertyCurvatureList, Points::PropertyNormalList, Points::PropertyGreyValueList, Path::PropertyTooltable, Path::PropertyTool, Path::PropertyPath, Part::PropertyFilletEdges, Part::PropertyShapeHistory, Part::PropertyPartShape, Part::PropertyGeometryList, Mesh::PropertyMeshKernel, Mesh::PropertyCurvatureList, Mesh::PropertyNormalList, Inspection::PropertyDistanceList, Fem::PropertyPostDataObject, Fem::PropertyFemMesh, App::PropertyMaterial, App::PropertyColor, App::PropertyBool, App::PropertyUUID, App::PropertyString, App::PropertyFloat, App::PropertyMap, App::PropertyIntegerSet, App::PropertyPath, App::PropertyInteger, App::PropertyPythonObject, App::PropertyMatrix, and App::PropertyFileIncluded.

Referenced by App::PropertyFileIncluded::getMemSize().

◆ getName()

const char * Property::getName ( void  ) const

get the name of this property in the belonging container

Referenced by App::DynamicProperty::addProperty(), Gui::PropertyEditor::PropertyModel::appendProperty(), Gui::PropertyEditor::PropertyModel::buildUp(), PartDesignGui::TaskHoleParameters::changedObject(), App::PropertyExpressionEngine::execute(), PartGui::ViewProviderSplineExtension::extensionUpdateData(), getPaths(), Part::PropertyPartShape::getPaths(), App::GeoFeaturePy::getPropertyNameOfGeometry(), TechDraw::DrawView::handleChangedPropertyType(), App::ObjectIdentifier::ObjectIdentifier(), PartGui::ViewProviderCustom::onChanged(), SketcherGui::ViewProviderCustom::onChanged(), PartDesign::Boolean::onChanged(), Gui::PropertyView::onTimer(), App::DocumentObjectT::operator=(), App::PropertyContainer::Restore(), Inspection::PropertyDistanceList::Save(), Mesh::PropertyNormalList::Save(), Mesh::PropertyCurvatureList::Save(), Part::PropertyFilletEdges::Save(), App::DocumentObjectPy::setCustomAttributes(), App::LinkBaseExtension::setProperty(), ShapeCache::slotChanged(), Gui::Document::slotChangedObject(), Spreadsheet::SheetObserver::slotChangedObject(), App::PropertyLinkBase::tryReplaceLink(), PartDesignGui::ViewProviderBody::unifyVisualProperty(), Gui::ViewProviderAnnotation::updateData(), Gui::ViewProviderAnnotationLabel::updateData(), Gui::ViewProviderInventorObject::updateData(), Gui::ViewProviderMeasureDistance::updateData(), Gui::ViewProviderVRMLObject::updateData(), FemGui::ViewProviderFemConstraintBearing::updateData(), FemGui::ViewProviderFemConstraintContact::updateData(), FemGui::ViewProviderFemConstraintDisplacement::updateData(), FemGui::ViewProviderFemConstraintFixed::updateData(), FemGui::ViewProviderFemConstraintFluidBoundary::updateData(), FemGui::ViewProviderFemConstraintForce::updateData(), FemGui::ViewProviderFemConstraintGear::updateData(), FemGui::ViewProviderFemConstraintHeatflux::updateData(), FemGui::ViewProviderFemConstraintPlaneRotation::updateData(), FemGui::ViewProviderFemConstraintPressure::updateData(), FemGui::ViewProviderFemConstraintPulley::updateData(), FemGui::ViewProviderFemConstraintTemperature::updateData(), FemGui::ViewProviderFemConstraintTransform::updateData(), FemGui::ViewProviderFemPostFunctionProvider::updateData(), InspectionGui::ViewProviderInspection::updateData(), PartDesignGui::ViewProviderDatumCoordinateSystem::updateData(), PartDesignGui::ViewProviderDatumLine::updateData(), PartDesignGui::ViewProviderDatumPlane::updateData(), Gui::ViewProviderDragger::updateData(), PartGui::ViewProviderPartExt::updateData(), PartDesignGui::ViewProvider::updateData(), FemGui::ViewProviderFemPostPipeline::updateData(), PartGui::ViewProviderSpline::updateData(), App::PropertyXLink::upgrade(), App::PropertyXLinkSubList::upgrade(), App::PropertyXLinkSub::upgrade(), and App::ObjectIdentifier::verify().

◆ getPaths()

void Property::getPaths ( std::vector< App::ObjectIdentifier > &  paths) const
virtual

Get valid paths for this property; used by auto completer.

Reimplemented in App::PropertyPlacement, App::PropertyVector, Sketcher::PropertyConstraintList, Part::PropertyPartShape, and Fem::PropertyPostDataObject.

References getContainer(), and getName().

◆ getPathValue()

◆ getPyPathValue()

virtual bool App::Property::getPyPathValue ( const App::ObjectIdentifier ,
Py::Object &   
) const
virtual

Get Python value of property.

Reimplemented in App::PropertyPlacement, App::PropertyVector, and Sketcher::PropertyConstraintList.

Referenced by App::ObjectIdentifier::getPyValue().

◆ getStatus()

◆ getType()

◆ hasSetChildValue()

virtual void App::Property::hasSetChildValue ( Property )
virtual

Called when a child property has changed value.

Reimplemented in App::PropertyXLinkSubList, and Spreadsheet::PropertySheet.

Referenced by App::PropertyXLink::hasSetValue().

◆ hasSetValue()

void Property::hasSetValue ( void  )
protectedvirtual

Gets called by all setValue() methods after the value has changed.

Reimplemented in Spreadsheet::PropertySheet, App::PropertyXLink, App::PropertyLinkBase, and App::PropertyExpressionEngine.

References App::PropertyContainer::onChanged(), StatusBits, and Touched.

Referenced by Mesh::PropertyMeshKernel::finishEditing(), Points::PropertyPointKernel::finishEditing(), App::PropertyLinkBase::hasSetValue(), Fem::PropertyFemMesh::Paste(), Fem::PropertyPostDataObject::Paste(), Mesh::PropertyNormalList::Paste(), Mesh::PropertyCurvatureList::Paste(), Mesh::PropertyMeshKernel::Paste(), Part::PropertyPartShape::Paste(), Path::PropertyPath::Paste(), Path::PropertyTool::Paste(), Path::PropertyTooltable::Paste(), Points::PropertyPointKernel::Paste(), Robot::PropertyTrajectory::Paste(), App::PropertyPythonObject::Paste(), Inspection::PropertyDistanceList::Paste(), Part::PropertyShapeHistory::Paste(), Part::PropertyFilletEdges::Paste(), App::PropertyPythonObject::Restore(), Mesh::PropertyMeshKernel::Restore(), Points::PropertyPointKernel::Restore(), App::PropertyPythonObject::RestoreDocFile(), Fem::PropertyFemMesh::RestoreDocFile(), Fem::PropertyPostDataObject::RestoreDocFile(), Mesh::PropertyMeshKernel::RestoreDocFile(), Path::PropertyPath::RestoreDocFile(), Points::PropertyPointKernel::RestoreDocFile(), Mesh::PropertyMeshKernel::setPointIndices(), App::PropertyPythonObject::setPyObject(), Mesh::PropertyNormalList::setValue(), Mesh::PropertyCurvatureList::setValue(), Fem::PropertyFemMesh::setValue(), Mesh::PropertyMeshKernel::setValue(), Points::PropertyPointKernel::setValue(), Part::PropertyShapeHistory::setValue(), Path::PropertyTool::setValue(), Path::PropertyPath::setValue(), Path::PropertyTooltable::setValue(), Part::PropertyPartShape::setValue(), Robot::PropertyTrajectory::setValue(), Fem::PropertyPostDataObject::setValue(), Inspection::PropertyDistanceList::setValue(), Spreadsheet::PropertyColumnWidths::setValue(), Part::PropertyFilletEdges::setValue(), Spreadsheet::PropertyRowHeights::setValue(), App::PropertyPythonObject::setValue(), Fem::PropertyFemMesh::setValuePtr(), Mesh::PropertyMeshKernel::setValuePtr(), Spreadsheet::PropertyColumnWidths::setValues(), Spreadsheet::PropertyRowHeights::setValues(), Mesh::PropertyNormalList::setValues(), Mesh::PropertyCurvatureList::setValues(), Part::PropertyFilletEdges::setValues(), Inspection::PropertyDistanceList::setValues(), Part::PropertyShapeHistory::setValues(), Mesh::PropertyMeshKernel::swapMesh(), Fem::PropertyFemMesh::transformGeometry(), Mesh::PropertyNormalList::transformGeometry(), Mesh::PropertyCurvatureList::transformGeometry(), Mesh::PropertyMeshKernel::transformGeometry(), Part::PropertyPartShape::transformGeometry(), and Points::PropertyPointKernel::transformGeometry().

◆ isReadOnly()

◆ isSinglePrecision()

bool App::Property::isSinglePrecision ( ) const

Gets precision of properties using floating point numbers.

References Single.

◆ isTouched()

bool App::Property::isTouched ( void  ) const

Test if this property is touched.

Referenced by App::RangeExpression::isTouched(), Inspection::Feature::mustExecute(), Mesh::Curvature::mustExecute(), Mesh::FixDefects::mustExecute(), Part::Compound::mustExecute(), Part::Mirroring::mustExecute(), Part::Boolean::mustExecute(), Part::Box::mustExecute(), Part::Circle::mustExecute(), Part::MultiCommon::mustExecute(), Part::CurveNet::mustExecute(), Part::MultiFuse::mustExecute(), Part::ImportBrep::mustExecute(), Part::ImportIges::mustExecute(), Part::ImportStep::mustExecute(), Part::Section::mustExecute(), Part::FilletBase::mustExecute(), Part::RuledSurface::mustExecute(), Part::Loft::mustExecute(), Part::Sweep::mustExecute(), Part::Thickness::mustExecute(), Part::Vertex::mustExecute(), Part::Line::mustExecute(), Part::Plane::mustExecute(), Part::Sphere::mustExecute(), Part::Ellipsoid::mustExecute(), Part::Cylinder::mustExecute(), Part::Prism::mustExecute(), Part::RegularPolygon::mustExecute(), Part::Cone::mustExecute(), Part::Torus::mustExecute(), Part::Helix::mustExecute(), Part::Spiral::mustExecute(), Part::Wedge::mustExecute(), Part::Ellipse::mustExecute(), PartDesign::Fillet::mustExecute(), PartDesign::Groove::mustExecute(), PartDesign::Helix::mustExecute(), PartDesign::Hole::mustExecute(), PartDesign::LinearPattern::mustExecute(), PartDesign::Loft::mustExecute(), PartDesign::Mirrored::mustExecute(), PartDesign::MultiTransform::mustExecute(), PartDesign::Pad::mustExecute(), PartDesign::Pipe::mustExecute(), PartDesign::Pocket::mustExecute(), PartDesign::PolarPattern::mustExecute(), PartDesign::Box::mustExecute(), PartDesign::Cylinder::mustExecute(), PartDesign::Sphere::mustExecute(), PartDesign::Cone::mustExecute(), PartDesign::Ellipsoid::mustExecute(), PartDesign::Torus::mustExecute(), PartDesign::Prism::mustExecute(), PartDesign::Wedge::mustExecute(), PartDesign::Revolution::mustExecute(), PartDesign::Scaled::mustExecute(), PartDesign::ProfileBased::mustExecute(), PartDesign::Thickness::mustExecute(), PartDesign::Transformed::mustExecute(), Sketcher::SketchObjectSF::mustExecute(), Surface::Cut::mustExecute(), Surface::Filling::mustExecute(), Surface::GeomFillSurface::mustExecute(), Surface::Sewing::mustExecute(), TechDraw::DrawRichAnno::mustExecute(), TechDraw::DrawViewCollection::mustExecute(), Part::Extrusion::mustExecute(), Part::Face::mustExecute(), Part::Offset::mustExecute(), Part::Offset2D::mustExecute(), Part::Revolution::mustExecute(), PartDesign::Body::mustExecute(), PartDesign::FeatureAddSub::mustExecute(), PartDesign::Boolean::mustExecute(), PartDesign::Chamfer::mustExecute(), Surface::Extend::mustExecute(), TechDraw::DrawLeaderLine::mustExecute(), TechDraw::DrawProjGroup::mustExecute(), TechDraw::DrawProjGroupItem::mustExecute(), TechDraw::DrawView::mustExecute(), TechDraw::DrawViewBalloon::mustExecute(), TechDraw::DrawViewDimension::mustExecute(), TechDraw::DrawViewPart::mustExecute(), App::Origin::mustExecute(), PartDesign::FeatureBase::mustExecute(), Sandbox::SandboxObject::mustExecute(), PartDesign::ShapeBinder::mustExecute(), and TechDrawGui::MDIViewPage::updateTemplate().

◆ onContainerRestored()

virtual void App::Property::onContainerRestored ( )
virtual

Called before calling DocumentObject::onDocumentRestored()

This function is called after finished calling Property::afterRestore() of all properties of objects. By then, the object dependency information is assumed ready. So, unlike Property::afterRestore(), this function is called on objects with dependency order.

Reimplemented in Spreadsheet::PropertySheet, App::PropertyXLinkSubList, App::PropertyXLink, App::PropertyLinkSubList, App::PropertyLinkSub, and App::PropertyExpressionEngine.

◆ Paste()

void Property::Paste ( const Property from)
pure virtual

Paste the value from the property (mainly for Undo/Redo and transactions)

Implemented in App::PropertyPersistentObject, App::PropertyMaterialList, App::PropertyColorList, App::PropertyBoolList, App::PropertyStringList, App::PropertyFloatList, App::PropertyIntegerList, App::PropertyXLinkSubList, App::PropertyXLink, App::PropertyLinkSubList, App::PropertyLinkSub, App::PropertyLinkList, App::PropertyLink, App::PropertyPlacementList, App::PropertyPlacement, App::PropertyVectorList, App::PropertyVector, App::PropertyExpressionEngine, App::PropertyMaterial, App::PropertyColor, App::PropertyBool, App::PropertyUUID, App::PropertyString, App::PropertyFloat, App::PropertyMap, App::PropertyIntegerSet, App::PropertyEnumeration, App::PropertyPath, App::PropertyInteger, App::PropertyPythonObject, App::PropertyPlacementLink, App::PropertyMatrix, App::PropertyFileIncluded, Sketcher::PropertyConstraintList, TechDraw::PropertyGeomFormatList, TechDraw::PropertyCosmeticVertexList, TechDraw::PropertyCosmeticEdgeList, TechDraw::PropertyCenterLineList, Spreadsheet::PropertyRowHeights, Robot::PropertyTrajectory, Points::PropertyPointKernel, Points::PropertyCurvatureList, Points::PropertyNormalList, Points::PropertyGreyValueList, Path::PropertyTooltable, Path::PropertyTool, Path::PropertyPath, Part::PropertyPartShape, Part::PropertyGeometryList, Mesh::PropertyMeshKernel, Mesh::PropertyCurvatureList, Mesh::PropertyNormalList, Fem::PropertyPostDataObject, and Fem::PropertyFemMesh.

Referenced by PartDesignGui::TaskFeaturePick::makeCopy(), PartDesignGui::ViewProviderBody::unifyVisualProperty(), and Spreadsheet::Sheet::updateAlias().

◆ purgeTouched()

◆ setContainer()

◆ setPathValue()

◆ setReadOnly()

void Property::setReadOnly ( bool  readOnly)

Sets property editable/grayed out in property editor.

References ReadOnly, and setStatus().

Referenced by PartDesign::Hole::onChanged(), Part::Revolution::onChanged(), and TechDraw::DrawViewDimension::onChanged().

◆ setSinglePrecision()

void App::Property::setSinglePrecision ( bool  single)

Sets precision of properties using floating point numbers to single, the default is double.

References Single.

◆ setStatus()

◆ setStatusValue()

◆ testStatus()

◆ touch()

◆ verifyPath()

void Property::verifyPath ( const App::ObjectIdentifier p) const
protectedvirtual

Verify a path for the current property.

Friends And Related Function Documentation

◆ DynamicProperty

friend class DynamicProperty
friend

◆ PropertyContainer

friend class PropertyContainer
friend

◆ PropertyData

friend struct PropertyData
friend

Member Data Documentation

◆ StatusBits

std::bitset<32> App::Property::StatusBits
protected

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.

The bits and their meaning are listed below: 0 - object is marked as 'touched' 1 - object is marked as 'immutable' 2 - object is marked as 'read-only' (for property editor) 3 - object is marked as 'hidden' (for property editor)

Referenced by App::DynamicProperty::addDynamicProperty(), hasSetValue(), App::PropertyContainer::Restore(), setStatus(), setStatusValue(), and touch().


The documentation for this class was generated from the following files:
  • Sources/FreeCAD/src/App/Property.h
  • Sources/FreeCAD/src/App/Property.cpp