Attacher::AttachEngine3D Class Reference

#include <Attacher.h>

Public Member Functions

 AttachEngine3D ()
virtual Base::Placement calculateAttachedPlacement (const Base::Placement &origPlacement) const
virtual AttachEngine3Dcopy () const
- Public Member Functions inherited from Attacher::AttachEngine
 AttachEngine ()
virtual Base::Placement calculateAttachedPlacement (const Base::Placement &origPlacement) const =0
virtual AttachEnginecopy () const =0
void EnableAllSupportedModes (void)
 EnableAllModes enables all modes that have shape type lists filled. More...
Base::Placement placementFactory (const gp_Dir &ZAxis, gp_Vec XAxis, gp_Pnt Origin, gp_Pnt refOrg=gp_Pnt(), bool useRefOrg_Line=false, bool useRefOrg_Plane=false, bool makeYVertical=false, bool makeLegacyFlatFaceOrientation=false, Base::Placement *placeOfRef=nullptr) const
 placementFactory calculates placement from Z axis direction, optional X axis direction, and origin point. More...
virtual void setUp (const App::PropertyLinkSubList &references, eMapMode mapMode=mmDeactivated, bool mapReverse=false, double attachParameter=0.0, double surfU=0.0, double surfV=0.0, const Base::Placement &attachmentOffset=Base::Placement())
virtual void setUp (const AttachEngine &another)
virtual void suggestMapModes (SuggestResult &result) const
 suggestMapModes is the procedure that knows everything about mapping modes. More...
virtual ~AttachEngine ()
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction. More...
 BaseClass (const BaseClass &)=default
virtual PyObjectgetPyObject ()
 This method returns the Python wrapper for a C++ object. More...
virtual Type getTypeId () const
bool isDerivedFrom (const Type type) const
BaseClassoperator= (const BaseClass &)=default
virtual void setPyObject (PyObject *)
virtual ~BaseClass ()
 Destruction. More...

Additional Inherited Members

- Static Public Member Functions inherited from Attacher::AttachEngine
static eRefType downgradeType (eRefType type)
 downgradeType converts a more-specific type into a less-specific type (e.g. More...
static GProp_GProps getInertialPropsOfShape (const std::vector< const TopoDS_Shape * > &shapes)
static eMapMode getModeByName (const std::string &modeName)
static std::string getModeName (eMapMode mmode)
 getModeName More...
static eRefType getRefTypeByName (const std::string &typeName)
static std::string getRefTypeName (eRefType shapeType)
static eRefType getShapeType (const App::DocumentObject *obj, const std::string &subshape)
 getShapeType by link content. More...
static eRefType getShapeType (const TopoDS_Shape &sh)
 getShapeType by shape. More...
static int getTypeRank (eRefType type)
 getTypeRank determines, how specific is the supplied shape type. More...
static int isShapeOfType (eRefType shapeType, eRefType requirement)
 isShapeOfType tests if a shape fulfills the requirement of a mode, and returns a score of how spot on was the requirement. More...
static void verifyReferencesAreSafe (const App::PropertyLinkSubList &references)
 verifyReferencesAreSafe: checks if pointers in references still point to objects contained in open documents. More...
- Static Public Member Functions inherited from Base::BaseClass
static void * create ()
static Type getClassTypeId ()
static void init ()
- Public Attributes inherited from Attacher::AttachEngine
Base::Placement attachmentOffset
double attachParameter
eMapMode mapMode
bool mapReverse
std::vector< boolmodeEnabled
 modeEnabled is an indicator, whether some mode is ever suggested or not. More...
std::vector< refTypeStringListmodeRefTypes
App::PropertyLinkSubList references
double surfU
double surfV
- Static Public Attributes inherited from Attacher::AttachEngine
static const char * eMapModeStrings []
static const char * eRefTypeStrings []
- Protected Member Functions inherited from Attacher::AttachEngine
refTypeString cat (eRefType rt1)
refTypeString cat (eRefType rt1, eRefType rt2)
refTypeString cat (eRefType rt1, eRefType rt2, eRefType rt3)
refTypeString cat (eRefType rt1, eRefType rt2, eRefType rt3, eRefType rt4)
- Static Protected Member Functions inherited from Attacher::AttachEngine
static void readLinks (const App::PropertyLinkSubList &references, std::vector< App::GeoFeature * > &geofs, std::vector< const TopoDS_Shape * > &shapes, std::vector< TopoDS_Shape > &storage, std::vector< eRefType > &types)
 AttachEngine3D::readLinks. More...
static void throwWrongMode (eMapMode mmode)
- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)

Constructor & Destructor Documentation

◆ AttachEngine3D()

Member Function Documentation

◆ calculateAttachedPlacement()

Base::Placement AttachEngine3D::calculateAttachedPlacement ( const Base::Placement origPlacement) const

Implements Attacher::AttachEngine.

References Attacher::AttachEngine::attachmentOffset, Attacher::AttachEngine::attachParameter, Base::Console(), Attacher::AttachEngine::getInertialPropsOfShape(), draftgeoutils.geometry::getNormal, Base::Placement::getPosition(), Base::Placement::getRotation(), Attacher::AttachEngine::isShapeOfType(), Base::Rotation::makeRotationByAxes(), Attacher::AttachEngine::mapMode, Attacher::AttachEngine::mapReverse, Attacher::mmConcentric, Attacher::mmDeactivated, Attacher::mmFlatFace, Attacher::mmFolding, Attacher::mmFrenetNB, Attacher::mmFrenetTB, Attacher::mmFrenetTN, Attacher::mmInertialCS, Attacher::mmNormalToPath, Attacher::mmObjectXY, Attacher::mmObjectXZ, Attacher::mmObjectYZ, Attacher::mmOXY, Attacher::mmOXZ, Attacher::mmOYX, Attacher::mmOYZ, Attacher::mmOZX, Attacher::mmOZY, Attacher::mmRevolutionSection, Attacher::mmTangentPlane, Attacher::mmThreePointsNormal, Attacher::mmThreePointsPlane, Attacher::mmTranslate, Base::Rotation::multVec(), Base::Placement::Placement(), Attacher::AttachEngine::placementFactory(), Attacher::AttachEngine::readLinks(), Attacher::AttachEngine::references, Attacher::rtConic, Attacher::rtFlagHasPlacement, Base::Placement::setPosition(), Base::Placement::setRotation(), Attacher::AttachEngine::throwWrongMode(), Base::ConsoleSingleton::Warning(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

Referenced by Attacher::AttachEnginePlane::calculateAttachedPlacement(), Attacher::AttachEngineLine::calculateAttachedPlacement(), and Attacher::AttachEnginePoint::calculateAttachedPlacement().

◆ copy()

AttachEngine3D * AttachEngine3D::copy ( void  ) const

Implements Attacher::AttachEngine.

References AttachEngine3D().

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