2D Shape This is a specialized version of the PartShape for use with flat (2D) geometry. More...

#include <Part2DObject.h>

Public Member Functions
virtual void acceptGeometry ()
	verify and accept the assigned geometry More...

virtual Base::Axis getAxis (int axId) const
	retrieves an axis iterating through the construction lines of the sketch (indices start at 0) More...

virtual int getAxisCount (void) const
	returns the number of construction lines (to be used as axes) More...

Part2DObject ()

virtual void transformPlacement (const Base::Placement &transform) override
	transformPlacement applies transform to placement of this shape. More...

Public Member Functions inherited from Part::Feature
Feature (void)
	Constructor. More...

virtual ~Feature ()

virtual short mustExecute () const override
	mustExecute We call this method to check if the object was modified to be invoked. More...

virtual const App::PropertyComplexGeoData * getPropertyOfGeometry () const override
	This method returns the main property of a geometric object that holds the actual geometry. More...

virtual PyObject * getPyObject () override
	getPyObject returns the Python binding object 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...

Base::Placement globalPlacement () const
	Calculates the placement in the global reference coordinate system. More...

virtual ~GeoFeature ()

Public Member Functions inherited from App::DocumentObject
virtual App::Property * addDynamicProperty (const char type, const char name=0, const char group=0, const char doc=0, short attr=0, bool ro=false, bool hidden=false) override

virtual bool adjustRelativeLinks (const std::set< App::DocumentObject * > &inList, std::set< App::DocumentObject * > *visited=0)
	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 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=0) 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=0, 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...

unsigned long getStatus () const
	return the status bits More...

const char * getStatusString (void) const
	get the status Message 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 * 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

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=0, std::string childName=0, const char subElement=0, PyObject pyObj=0, Base::Matrix4D *mat=0, 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, boost::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
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 * getDynamicPropertyByName (const char *name) const

DynamicProperty::PropData getDynamicPropertyData (const Property *prop) 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...

const char * getPropertyPrefix () const

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

PropertyContainer ()
	A constructor. 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 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 void setPyObject (PyObject *)

virtual ~BaseClass ()
	Destruction. More...

Public Member Functions inherited from Part::AttachExtension
Attacher::AttachEngine & attacher (void) const

AttachExtension ()

bool changeAttacherType (const char *typeName)
	changeAttacherType More...

virtual App::DocumentObjectExecReturn * extensionExecute (void)

virtual short int extensionMustExecute (void)

virtual PyObject * getExtensionPyObject (void)

bool isAttacherActive () const
	Return whether this attacher is active. More...

virtual bool isTouched_Mapping ()

virtual void onExtendedDocumentRestored ()
	get called after a document has been fully restored More...

virtual bool positionBySupport (void)
	calculate and update the Placement property based on the Support, and mode. More...

virtual void setAttacher (Attacher::AttachEngine *attacher)
	setAttacher sets the AttachEngine object. More...

void updateAttacherVals ()

virtual ~AttachExtension ()

Public Member Functions inherited from App::DocumentObjectExtension
DocumentObjectExtension ()

virtual bool extensionGetLinkedObject (DocumentObject &ret, bool recursive, Base::Matrix4D mat, bool transform, int depth) const
	Get the linked object. More...

virtual bool extensionGetSubObject (DocumentObject &ret, const char subname, PyObject *pyObj, Base::Matrix4D mat, bool transform, int depth) const
	Get the sub object by name. More...

virtual bool extensionGetSubObjects (std::vector< std::string > &ret, int reason) const
	Get name references of all sub objects. More...

virtual bool extensionHasChildElement () const

virtual int extensionIsElementVisible (const char *)

virtual int extensionSetElementVisible (const char *, bool)

App::DocumentObject * getExtendedObject ()

const App::DocumentObject * getExtendedObject () const

virtual const char * getViewProviderExtensionName (void) const
	returns the type name of the ViewProviderExtension which is automatically attached to the viewprovider object when it is initiated More...

virtual void onExtendedSettingDocument ()
	get called after setting the document More...

virtual void onExtendedSetupObject ()
	get called after a brand new object was created More...

virtual void onExtendedUnsetupObject ()
	get called when object is going to be removed from the document More...

virtual ~DocumentObjectExtension ()

Public Member Functions inherited from App::Extension
Extension ()

App::ExtensionContainer * getExtendedContainer ()

const App::ExtensionContainer * getExtendedContainer () const

virtual void initExtension (App::ExtensionContainer *obj)

bool isPythonExtension ()

std::string name () const

virtual ~Extension ()

virtual Property * extensionGetPropertyByName (const char *name) const
	find a property by its name More...

virtual const char * extensionGetPropertyName (const Property *prop) const
	get the name of a property More...

virtual void extensionGetPropertyMap (std::map< std::string, Property * > &Map) const
	get all properties of the class (including properties of the parent) More...

virtual void extensionGetPropertyList (std::vector< Property * > &List) const
	get all properties of the class (including properties of the parent) More...

virtual short extensionGetPropertyType (const Property *prop) const
	get the Type of a Property More...

virtual short extensionGetPropertyType (const char *name) const
	get the Type of a named Property More...

virtual const char * extensionGetPropertyGroup (const Property *prop) const
	get the Group of a Property More...

virtual const char * extensionGetPropertyGroup (const char *name) const
	get the Group of a named Property More...

virtual const char * extensionGetPropertyDocumentation (const Property *prop) const
	get the Group of a Property More...

virtual const char * extensionGetPropertyDocumentation (const char *name) const
	get the Group of a named Property More...

virtual void extensionSave (Base::Writer &) const

virtual void extensionRestore (Base::XMLReader &)

bool extensionIsDerivedFrom (const Base::Type type) const

Static Public Member Functions
static bool seekTrimPoints (const std::vector< Geometry * > &geomlist, int GeoId, const Base::Vector3d &point, int &GeoId1, Base::Vector3d &intersect1, int &GeoId2, Base::Vector3d &intersect2)
	calculate the points where a curve with index GeoId should be trimmed with respect to the rest of the curves contained in the list geomlist and a picked point. More...

Static Public Member Functions inherited from Part::Feature
static TopoDS_Shape getShape (const App::DocumentObject obj, const char subname=0, bool needSubElement=false, Base::Matrix4D pmat=0, App::DocumentObject *owner=0, 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=0, bool needSubElement=false, Base::Matrix4D pmat=0, App::DocumentObject *owner=0, bool resolveLink=true, bool transform=true, bool noElementMap=false)

static void clearShapeCache ()

static App::DocumentObject * getShapeOwner (const App::DocumentObject obj, const char subname=0)

static bool hasShapeOwner (const App::DocumentObject obj, const char subname=0)

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=0, const char element=0, GeoFeature *geo=0)
	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 (void)

static Type getClassTypeId (void)

static void init (void)

Static Public Attributes
static const int H_Axis = -1

static const int N_Axis = -3

static const int V_Axis = -2

Static Public Attributes inherited from App::DocumentObject
static DocumentObjectExecReturn * StdReturn

methods override Feature
App::DocumentObjectExecReturn * execute (void) override
	recalculate the Feature More...

const char * getViewProviderName (void) const override
	returns the type name of the ViewProvider More...

void Restore (Base::XMLReader &reader) override
	This method is used to restore properties from an XML document. More...

void handleChangedPropertyType (Base::XMLReader &reader, const char TypeName, App::Property prop) override
	PropertyContainer::handleChangedPropertyType is called during restore to possibly fix reading of older versions of the property container. More...

void handleChangedPropertyName (Base::XMLReader &reader, const char TypeName, const char PropName) override
	PropertyContainer::handleChangedPropertyName is called during restore to possibly fix reading of older versions of this property container. More...

Additional Inherited Members
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

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

Public Attributes inherited from Part::AttachExtension
App::PropertyString AttacherType

App::PropertyPlacement AttachmentOffset

App::PropertyEnumeration MapMode

App::PropertyFloat MapPathParameter
	MapPathParameter is a parameter value for mmNormalToPath (the sketch will be mapped normal to a curve at point specified by parameter (from 0.0 to 1.0, from start to end) ) More...

App::PropertyBool MapReversed

App::PropertyLinkSubList Support

Protected Member Functions inherited from Part::Feature
virtual App::DocumentObjectExecReturn * recompute () override
	recompute only this object More...

virtual void onChanged (const App::Property *prop) override
	get called by the container when a property was changed 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 void onBeforeChange (const Property *prop) override
	get called before the value is 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...

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

Protected Member Functions inherited from Part::AttachExtension
virtual void extensionOnChanged (const App::Property *)

virtual void extHandleChangedPropertyName (Base::XMLReader &reader, const char TypeName, const char PropName)

App::PropertyPlacement & getPlacement () const

Protected Member Functions inherited from App::Extension
void initExtensionType (Base::Type type)

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)

Static Protected Member Functions inherited from App::Extension
static void initExtensionSubclass (Base::Type &toInit, const char ClassName, const char ParentName, Base::Type::instantiationMethod method=0)

Protected Attributes inherited from App::DocumentObject
std::string oldLabel
	Old label; used for renaming expressions. More...

const std::string * pcNameInDocument

Py::Object 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

Protected Attributes inherited from App::Extension
bool m_isPythonExtension = false

Py::Object ExtensionPythonObject

Detailed Description

2D Shape This is a specialized version of the PartShape for use with flat (2D) geometry.

The Z direction has always to be 0. The position and orientation of the Plane this 2D geometry is referenced is defined by the Placement property. It also has a link to a supporting Face which defines the position in space where it is located. If the support is changed the static method positionBySupport() is used to calculate a new position for the Part2DObject. This object can be used stand alone or for constraint geometry as its descend Sketcher::SketchObject .

Constructor & Destructor Documentation

◆ Part2DObject()

Part2DObject::Part2DObject ( )

References App::Extension::initExtension().

Member Function Documentation

◆ acceptGeometry()

void Part2DObject::acceptGeometry ( )

virtual

verify and accept the assigned geometry

Reimplemented in Sketcher::SketchObject.

Referenced by Part::PropertyGeometryList::setPyObject().

◆ execute()

App::DocumentObjectExecReturn * Part2DObject::execute ( void )

overridevirtual

recalculate the Feature

Reimplemented from Part::Feature.

Reimplemented in Sketcher::SketchObject, and Sketcher::SketchObjectSF.

References Part::Feature::execute().

Referenced by PathScripts.PathDressupDogbone.ObjectDressup::boneStateList(), ArchSite.Compass::buildCoordinates(), PathScripts.PathDressupHoldingTags.ObjectTagDressup::generateTags(), ArchSchedule.CommandArchSchedule::IsActive(), Mod.PartDesign.Scripts.Spring.MySpring::onChanged(), Mod.PartDesign.Scripts.Epitrochoid.Epitrochoid::onChanged(), Mod.PartDesign.Scripts.Parallelepiped.Parallelepiped::onChanged(), Mod.PartDesign.Scripts.DistanceBolt.DistanceBolt::onChanged(), Mod.PartDesign.Scripts.Parallelepiped.BoxCylinder::onChanged(), PathScripts.PathStock.StockFromBase::onChanged(), PathScripts.PathStock.StockCreateBox::onChanged(), PathScripts.PathStock.StockCreateCylinder::onChanged(), and FeaturePython.DistanceBolt::onChanged().

◆ getAxis()

Base::Axis Part2DObject::getAxis ( int axId ) const

virtual

retrieves an axis iterating through the construction lines of the sketch (indices start at 0)

Reimplemented in Sketcher::SketchObject.

References H_Axis, N_Axis, and V_Axis.

Referenced by PartDesign::ProfileBased::getAxis(), Sketcher::SketchObject::getAxis(), PartDesign::Mirrored::getTransformations(), PartDesign::LinearPattern::getTransformations(), and PartDesign::PolarPattern::getTransformations().

◆ getAxisCount()

int Part2DObject::getAxisCount ( void ) const

virtual

returns the number of construction lines (to be used as axes)

Reimplemented in Sketcher::SketchObject.

Referenced by PartDesignGui::TaskRevolutionParameters::fillAxisCombo(), PartDesignGui::TaskTransformedParameters::fillAxisCombo(), PartDesignGui::TaskTransformedParameters::fillPlanesCombo(), and PartDesign::ProfileBased::getSketchAxisCount().

◆ getViewProviderName()

const char* Part::Part2DObject::getViewProviderName ( void ) const

overridevirtual

returns the type name of the ViewProvider

Reimplemented from Part::Feature.

Reimplemented in Sketcher::SketchObject.

◆ handleChangedPropertyName()

void Part2DObject::handleChangedPropertyName	(	Base::XMLReader &	reader,
		const char *	TypeName,
		const char *	PropName
	)

overrideprotectedvirtual

PropertyContainer::handleChangedPropertyName is called during restore to possibly fix reading of older versions of this property container.

This method is typically called if the property on file has changed its name in more recent versions.

The default implementation does nothing.

Parameters

reader	The XML stream to read from.
TypeName	Name of property type on file.
PropName	Name of property on file that does not exist in the container anymore.

Reimplemented from App::PropertyContainer.

References Part::AttachExtension::extHandleChangedPropertyName().

◆ handleChangedPropertyType()

void Part2DObject::handleChangedPropertyType	(	Base::XMLReader &	reader,
		const char *	TypeName,
		App::Property *	prop
	)

overrideprotectedvirtual

PropertyContainer::handleChangedPropertyType is called during restore to possibly fix reading of older versions of the property container.

This method is typically called if the property on file has changed its type in more recent versions.

The default implementation does nothing.

Parameters

reader	The XML stream to read from.
TypeName	Name of property type on file.
prop	Pointer to property to restore. Its type differs from TypeName.

Reimplemented from App::PropertyContainer.

References Base::Persistence::getClassTypeId(), Base::Type::getName(), App::PropertyLinkSub::getSubValues(), Base::Persistence::getTypeId(), App::PropertyLinkSub::getValue(), Base::BaseClass::isDerivedFrom(), Part::AttachExtension::MapMode, Attacher::mmFlatFace, App::PropertyLinkSub::Restore(), App::Property::setContainer(), and App::PropertyEnumeration::setValue().

◆ Restore()

void Part2DObject::Restore ( Base::XMLReader & )

overridevirtual

This method is used to restore properties from an XML document.

It uses the XMLReader class, which bases on SAX, to read the in Save() written information. Again the Vector as an example:

void PropertyVector::Restore(Base::XMLReader &reader)
{
  // read my Element
  reader.readElement("PropertyVector");
  // get the value of my Attribute
  _cVec.x = reader.getAttributeAsFloat("valueX");
  _cVec.y = reader.getAttributeAsFloat("valueY");
  _cVec.z = reader.getAttributeAsFloat("valueZ");
}

Reimplemented from App::ExtensionContainer.

Reimplemented in Sketcher::SketchObject.

References App::ExtensionContainer::Restore().

Referenced by Sketcher::SketchObject::Restore().

◆ seekTrimPoints()

bool Part2DObject::seekTrimPoints	(	const std::vector< Geometry * > &	geomlist,
		int	GeoId,
		const Base::Vector3d &	point,
		int &	GeoId1,
		Base::Vector3d &	intersect1,
		int &	GeoId2,
		Base::Vector3d &	intersect2
	)

static

calculate the points where a curve with index GeoId should be trimmed with respect to the rest of the curves contained in the list geomlist and a picked point.

The outputs intersect1 and intersect2 specify the tightest boundaries for trimming around the picked point and the indexes GeoId1 and GeoId2 specify the corresponding curves that intersect the curve GeoId.

References Base::Persistence::getClassTypeId(), Part::GeomBoundedCurve::getEndPoint(), Part::GeomBoundedCurve::getStartPoint(), Base::Persistence::getTypeId(), Base::BaseClass::isDerivedFrom(), Base::Vector3< _Precision >::x, and Base::Vector3< _Precision >::y.

◆ transformPlacement()

void Part2DObject::transformPlacement ( const Base::Placement & transform )

overridevirtual

transformPlacement applies transform to placement of this shape.

Override this function to propagate the change of placement to base features, for example. By the time of writing this comment, the function was only called by alignment task (Edit->Alignment)

Parameters

transform (input).

Reimplemented from App::GeoFeature.

References App::PropertyLinkSubList::getValues(), Part::AttachExtension::positionBySupport(), and Part::AttachExtension::Support.

Referenced by PartDesign::ProfileBased::transformPlacement().

Member Data Documentation

◆ H_Axis

const int Part2DObject::H_Axis = -1

static

Referenced by getAxis(), PartDesign::ProfileBased::getAxis(), PartDesign::Mirrored::getTransformations(), PartDesign::LinearPattern::getTransformations(), and PartDesign::PolarPattern::getTransformations().

◆ N_Axis

const int Part2DObject::N_Axis = -3

static

Referenced by getAxis(), PartDesign::Mirrored::getTransformations(), PartDesign::LinearPattern::getTransformations(), and PartDesign::PolarPattern::getTransformations().

◆ V_Axis

const int Part2DObject::V_Axis = -2

static

Referenced by getAxis(), PartDesign::ProfileBased::getAxis(), PartDesign::Mirrored::getTransformations(), PartDesign::LinearPattern::getTransformations(), and PartDesign::PolarPattern::getTransformations().

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

src/Mod/Part/App/Part2DObject.h
src/Mod/Part/App/Part2DObject.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

methods override Feature

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Part2DObject()

Member Function Documentation

◆ acceptGeometry()

◆ execute()

◆ getAxis()

◆ getAxisCount()

◆ getViewProviderName()

◆ handleChangedPropertyName()

◆ handleChangedPropertyType()

◆ Restore()

◆ seekTrimPoints()

◆ transformPlacement()

Member Data Documentation

◆ H_Axis

◆ N_Axis

◆ V_Axis