Mesh::SegmentByMesh Class Reference

The SegmentByMesh class creates a mesh segment from two meshes whereat the facets of the first mesh that lie inside the second mesh build up the segment. More...

#include <FeatureMeshSegmentByMesh.h>

Public Member Functions

 SegmentByMesh ()
 
methods overide 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...
 
- Public Member Functions inherited from Mesh::Feature
 Feature (void)
 Constructor. More...
 
virtual PyObjectgetPyObject (void)
 handles the MeshPy object More...
 
virtual const char * getViewProviderName (void) const
 returns the type name of the ViewProvider More...
 
virtual ~Feature ()
 
virtual void onChanged (const App::Property *prop)
 get called by the container when a property was changed More...
 
- Public Member Functions inherited from App::GeoFeature
 GeoFeature (void)
 Constructor. 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 void connectRelabelSignals ()
 
virtual const char * detachFromDocument ()
 
 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
 
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
 
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...
 
const char * getStatusString (void) const
 get the status Message More...
 
virtual bool isAttachedToDocument () const
 
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...
 
bool recomputeFeature ()
 Recompute only this feature. 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)
 
bool testIfLinkDAGCompatible (DocumentObject *linkTo) const
 testIfLinkIsDAG tests a link that is about to be created for circular references. More...
 
bool testIfLinkDAGCompatible (const std::vector< DocumentObject * > &linksTo) const
 
bool testIfLinkDAGCompatible (App::PropertyLinkSubList &linksTo) const
 
bool testIfLinkDAGCompatible (App::PropertyLinkSub &linkTo) const
 
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...
 
bool isDeleting () 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)
 
std::vector< App::DocumentObject * > getOutList (void) const
 DAG handling This part of the interface deals with viewing the document as an DAG (directed acyclic graph). 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< App::DocumentObject * > getInList (void) const
 get all objects link to this object More...
 
std::vector< App::DocumentObject * > getInListRecursive (void) const
 get all objects link directly or indirectly to this object More...
 
DocumentObjectGroupgetGroup () const
 get group if object is part of a group, otherwise 0 is returned More...
 
bool isInInListRecursive (DocumentObject *objToTest) const
 test if this object is in the InList and recursive further down More...
 
bool isInInList (DocumentObject *objToTest) const
 test if this object is directly (non recursive) in the InList More...
 
bool isInOutListRecursive (DocumentObject *objToTest) const
 test if the given object is in the OutList and recursive further down More...
 
bool isInOutList (DocumentObject *objToTest) const
 test if this object is directly (non recursive) in the OutList More...
 
- Public Member Functions inherited from App::TransactionalObject
virtual App::PropertyaddDynamicProperty (const char *, const char *=0, const char *=0, const char *=0, short=0, bool=false, bool=false)
 
virtual bool removeDynamicProperty (const char *)
 
 TransactionalObject (void)
 Constructor. More...
 
virtual ~TransactionalObject ()
 
- Public Member Functions inherited from App::ExtensionContainer
ExtensionIterator extensionBegin ()
 
 ExtensionContainer ()
 
ExtensionIterator extensionEnd ()
 
App::ExtensiongetExtension (Base::Type)
 
App::ExtensiongetExtension (const std::string &name)
 
template<typename ExtensionT >
ExtensionTgetExtensionByType ()
 
std::vector< Extension * > getExtensionsDerivedFrom (Base::Type type) const
 
template<typename ExtensionT >
std::vector< ExtensionT * > getExtensionsDerivedFromType () const
 
bool hasExtension (Base::Type) const
 
bool hasExtension (const std::string &name) const
 
bool hasExtensions () const
 
void registerExtension (Base::Type extension, App::Extension *ext)
 
virtual void Restore (Base::XMLReader &reader)
 This method is used to restore properties from an XML document. More...
 
void restoreExtensions (Base::XMLReader &reader)
 
void saveExtensions (Base::Writer &writer) const
 
virtual ~ExtensionContainer ()
 
virtual PropertygetPropertyByName (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...
 
- Public Member Functions inherited from App::PropertyContainer
virtual void addDynamicProperties (const PropertyContainer *)
 
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...
 
bool isHidden (const Property *prop) const
 check if the property is hidden More...
 
bool isHidden (const char *name) const
 check if the named property is hidden More...
 
bool isReadOnly (const Property *prop) const
 check if the property is read-only More...
 
bool isReadOnly (const char *name) const
 check if the named property is read-only More...
 
 PropertyContainer ()
 A constructor. More...
 
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::PropertyVector Base
 
App::PropertyVector Normal
 
App::PropertyLink Source
 
App::PropertyLink Tool
 
- Public Attributes inherited from Mesh::Feature
PropertyMeshKernel Mesh
 Property that holds the mesh data. More...
 
- Public Attributes inherited from App::GeoFeature
PropertyPlacement Placement
 
- Public Attributes inherited from App::DocumentObject
PropertyExpressionEngine ExpressionEngine
 
PropertyString Label
 

Additional Inherited Members

- Public Types inherited from App::ExtensionContainer
typedef std::map< Base::Type, App::Extension * >::iterator ExtensionIterator
 
- 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 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...
 
virtual App::DocumentObjectExecReturnrecompute (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 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
std::string oldLabel
 Old label; used for renaming expressions. More...
 
boost::BOOST_SIGNALS_NAMESPACE::scoped_connection onDeletedObjectConnection
 
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

The SegmentByMesh class creates a mesh segment from two meshes whereat the facets of the first mesh that lie inside the second mesh build up the segment.

Author
Werner Mayer

Constructor & Destructor Documentation

SegmentByMesh::SegmentByMesh ( void  )

Member Function Documentation

App::DocumentObjectExecReturn * SegmentByMesh::execute ( void  )
virtual
short SegmentByMesh::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 App::DocumentObject.

Member Data Documentation

App::PropertyVector Mesh::SegmentByMesh::Base
App::PropertyVector Mesh::SegmentByMesh::Normal
App::PropertyLink Mesh::SegmentByMesh::Source
App::PropertyLink Mesh::SegmentByMesh::Tool

The documentation for this class was generated from the following files:
  • src/src/Mod/Mesh/App/FeatureMeshSegmentByMesh.h
  • src/src/Mod/Mesh/App/FeatureMeshSegmentByMesh.cpp