Base::PlacementPy Class Reference

The python export class for Placement. More...

#include <PlacementPy.h>

Public Types
typedef Placement *	PointerType
Public Types inherited from Base::PyObjectBase
typedef void *	PointerType
enum	Status { Valid = 0, Immutable = 1, Notify = 2, NoTrack = 3 }

Public Member Functions
virtual PyTypeObject *	GetType (void)
	PlacementPy (Placement *pcObject, PyTypeObject *T=&Type)
virtual int	PyInit (PyObject *args, PyObject *k)
	PyInit method Override this method to initialize a newly created instance of the class (Constructor) More...
std::string	representation (void) const
Public Member Functions inherited from Base::PyObjectBase
PyObjectBase *	DecRef (void)
	decref method wrapper (see python extending manual) More...
PyObjectBase *	IncRef (void)
	incref method wrapper (see python extending manual) More...
bool	isConst ()
bool	isNotTracking () const
bool	isValid ()
	PyObjectBase (void *, PyTypeObject *T)
	Constructor Sets the Type of the object (for inheritance) and decrease the the reference count of the PyObject. More...
void	setConst ()
void	setInvalid ()
void	setNotTracking (bool on=true)
void	setShouldNotify (bool on)
bool	shouldNotify () const
void	startNotify ()

Static Public Member Functions
static PyObject *	PyMake (struct _typeobject *, PyObject *, PyObject *)
static PyObject *	richCompare (PyObject *v, PyObject *w, int op)
Static Public Member Functions inherited from Base::PyObjectBase
static void	PyDestructor (PyObject *P)
	Wrapper for the Python destructor. More...

Static Public Attributes
static PyGetSetDef	GetterSetter []
	Attribute structure of PlacementPy. More...
static PyMethodDef	Methods []
	Methods structure of PlacementPy. More...
static PyTypeObject	Type
	Type structure of PlacementPy. More...
Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef	Methods []
static PyTypeObject	Type
	Py_Header struct from python.h. More...

Protected Member Functions
	~PlacementPy ()
Protected Member Functions inherited from Base::PyObjectBase
virtual	~PyObjectBase ()
	destructor More...

callbacks and implementers for the python object methods
static PyObject *	staticCallback_copy (PyObject *self, PyObject *args)
	callback for the copy() method More...
static PyObject *	staticCallback_move (PyObject *self, PyObject *args)
	callback for the move() method More...
static PyObject *	staticCallback_multiply (PyObject *self, PyObject *args)
	callback for the multiply() method More...
static PyObject *	staticCallback_multVec (PyObject *self, PyObject *args)
	callback for the multVec() method More...
static PyObject *	staticCallback_toMatrix (PyObject *self, PyObject *args)
	callback for the toMatrix() method More...
static PyObject *	staticCallback_inverse (PyObject *self, PyObject *args)
	callback for the inverse() method More...
static PyObject *	staticCallback_isIdentity (PyObject *self, PyObject *args)
	callback for the isIdentity() method More...
PyObject *	copy (PyObject *args)
	implementer for the copy() method More...
PyObject *	move (PyObject *args)
	implementer for the move() method More...
PyObject *	multiply (PyObject *args)
	implementer for the multiply() method More...
PyObject *	multVec (PyObject *args)
	implementer for the multVec() method More...
PyObject *	toMatrix (PyObject *args)
	implementer for the toMatrix() method More...
PyObject *	inverse (PyObject *args)
	implementer for the inverse() method More...
PyObject *	isIdentity (PyObject *args)
	implementer for the isIdentity() method More...

callbacks and implementers for the python object attributes
static PyObject *	staticCallback_getBase (PyObject *self, void *closure)
	getter callback for the Base attribute More...
static int	staticCallback_setBase (PyObject *self, PyObject *value, void *closure)
	setter callback for the Base attribute More...
static PyObject *	staticCallback_getRotation (PyObject *self, void *closure)
	getter callback for the Rotation attribute More...
static int	staticCallback_setRotation (PyObject *self, PyObject *value, void *closure)
	setter callback for the Rotation attribute More...
Py::Object	getBase (void) const
	getter for the Base attribute More...
void	setBase (Py::Object arg)
	setter for the Base attribute More...
Py::Object	getRotation (void) const
	getter for the Rotation attribute More...
void	setRotation (Py::Object arg)
	setter for the Rotation attribute More...
PyObject *	getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones) More...
int	setCustomAttributes (const char *attr, PyObject *obj)
	setter for special attributes (e.g. More...
Placement *	getPlacementPtr (void) const
	getter for the object handled by this class More...

Additional Inherited Members
Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 >	StatusBits

Detailed Description

The python export class for Placement.

Member Typedef Documentation

PointerType

typedef Placement* Base::PlacementPy::PointerType

Constructor & Destructor Documentation

~PlacementPy()

PlacementPy::~PlacementPy ( )

protected

PlacementPy()

PlacementPy::PlacementPy	(	Placement *	pcObject,
		PyTypeObject *	T = &Type
	)

Referenced by copy(), inverse(), multiply(), and PyMake().

Member Function Documentation

copy()

PyObject * PlacementPy::copy

(

PyObject *

args

)

implementer for the copy() method

References getPlacementPtr(), and PlacementPy().

Referenced by staticCallback_copy().

getBase()

Py::Object PlacementPy::getBase

(

void

)

const

getter for the Base attribute

References getPlacementPtr().

Referenced by staticCallback_getBase().

getCustomAttributes()

PyObject * PlacementPy::getCustomAttributes

(

const char *

attr

)

const

getter method for special attributes (e.g. dynamic ones)

getPlacementPtr()

Placement * PlacementPy::getPlacementPtr

(

void

)

const

getter for the object handled by this class

Referenced by copy(), getBase(), getRotation(), inverse(), isIdentity(), move(), Base::AxisPy::multiply(), multiply(), multVec(), PyInit(), richCompare(), Attacher::AttachEnginePy::setAttachmentOffset(), setBase(), Gui::ViewProviderLinkPy::setDraggingPlacement(), Fem::PropertyFemMesh::setPyObject(), setRotation(), Robot::Robot6AxisPy::setTcp(), Gui::ViewProviderPy::setTransformation(), and toMatrix().

getRotation()

Py::Object PlacementPy::getRotation

(

void

)

const

getter for the Rotation attribute

References getPlacementPtr().

Referenced by staticCallback_getRotation().

GetType()

virtual PyTypeObject* Base::PlacementPy::GetType ( void  )

virtual

Reimplemented from Base::PyObjectBase.

inverse()

PyObject * PlacementPy::inverse

(

PyObject *

args

)

implementer for the inverse() method

References getPlacementPtr(), Base::Placement::inverse(), and PlacementPy().

Referenced by staticCallback_inverse().

isIdentity()

PyObject * PlacementPy::isIdentity

(

PyObject *

args

)

implementer for the isIdentity() method

References getPlacementPtr(), and Base::Placement::isIdentity().

Referenced by ArchComponent.Component::applyShape(), ArchComponent.Component::getExtrusionData(), ArchComponent.Component::processSubShapes(), and staticCallback_isIdentity().

move()

PyObject * PlacementPy::move

(

PyObject *

args

)

implementer for the move() method

References getPlacementPtr(), Base::Placement::move(), and Base::VectorPy::Type.

Referenced by draftguitools.gui_circulararray.CircularArray::Activated(), draftguitools.gui_polararray.PolarArray::Activated(), and staticCallback_move().

multiply()

PyObject * PlacementPy::multiply

(

PyObject *

args

)

implementer for the multiply() method

References getPlacementPtr(), PlacementPy(), and Type.

Referenced by PathScripts.PathDressupLeadInOut.ObjectDressup::getLeadEnd(), PathScripts.PathDressupLeadInOut.ObjectDressup::getLeadStart(), and staticCallback_multiply().

multVec()

PyObject * PlacementPy::multVec

(

PyObject *

args

)

implementer for the multVec() method

References getPlacementPtr(), Base::Placement::multVec(), and Base::VectorPy::Type.

Referenced by staticCallback_multVec().

PyInit()

int PlacementPy::PyInit ( PyObject *  , PyObject *    )

virtual

PyInit method Override this method to initialize a newly created instance of the class (Constructor)

Reimplemented from Base::PyObjectBase.

References DraftVecUtils::angle(), Base::BaseExceptionFreeCADError, Base::Placement::fromMatrix(), getPlacementPtr(), Base::Placement::setPosition(), Base::Placement::setRotation(), Base::MatrixPy::Type, Base::RotationPy::Type, Type, and Base::VectorPy::Type.

PyMake()

PyObject * PlacementPy::PyMake ( struct _typeobject *  , PyObject *  , PyObject *    )

static

References PlacementPy().

representation()

std::string PlacementPy::representation

(

void

)

const

References Base::Placement::getPosition(), Base::Placement::getRotation(), Base::Rotation::getYawPitchRoll(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

Referenced by config_control_design.pcurve::wr1(), config_control_design.degenerate_pcurve::wr1(), automotive_design.motion_link_relationship::wr1(), automotive_design.pcurve::wr1(), automotive_design.degenerate_pcurve::wr1(), config_control_design.pcurve::wr2(), config_control_design.degenerate_pcurve::wr2(), automotive_design.pcurve::wr2(), and automotive_design.degenerate_pcurve::wr2().

richCompare()

PyObject * PlacementPy::richCompare ( PyObject *  v, PyObject *  w, int  op  )

static

References getPlacementPtr(), and Type.

setBase()

void PlacementPy::setBase

(

Py::Object

arg

)

setter for the Base attribute

References getPlacementPtr(), Base::Placement::setPosition(), and Base::toVector().

Referenced by staticCallback_setBase().

setCustomAttributes()

int PlacementPy::setCustomAttributes	(	const char *	attr,
		PyObject *	obj
	)

setter for special attributes (e.g.

dynamic ones) Output: Success=1, Failure=-1, Ignore=0

setRotation()

void PlacementPy::setRotation

(

Py::Object

arg

)

setter for the Rotation attribute

References getPlacementPtr(), and Base::Placement::setRotation().

Referenced by staticCallback_setRotation().

staticCallback_copy()

PyObject * PlacementPy::staticCallback_copy ( PyObject *  self, PyObject *  args  )

static

callback for the copy() method

References Base::BaseExceptionFreeCADError, Base::Console(), copy(), Base::ConsoleSingleton::Error(), and Base::PyObjectBase::isValid().

staticCallback_getBase()

PyObject * PlacementPy::staticCallback_getBase ( PyObject *  self, void *  closure  )

static

getter callback for the Base attribute

References Base::BaseExceptionFreeCADError, getBase(), and Base::PyObjectBase::isValid().

staticCallback_getRotation()

PyObject * PlacementPy::staticCallback_getRotation ( PyObject *  self, void *  closure  )

static

getter callback for the Rotation attribute

References Base::BaseExceptionFreeCADError, getRotation(), and Base::PyObjectBase::isValid().

staticCallback_inverse()

PyObject * PlacementPy::staticCallback_inverse ( PyObject *  self, PyObject *  args  )

static

callback for the inverse() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), inverse(), and Base::PyObjectBase::isValid().

staticCallback_isIdentity()

PyObject * PlacementPy::staticCallback_isIdentity ( PyObject *  self, PyObject *  args  )

static

callback for the isIdentity() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), isIdentity(), and Base::PyObjectBase::isValid().

staticCallback_move()

PyObject * PlacementPy::staticCallback_move ( PyObject *  self, PyObject *  args  )

static

callback for the move() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), move(), and Base::PyObjectBase::startNotify().

staticCallback_multiply()

PyObject * PlacementPy::staticCallback_multiply ( PyObject *  self, PyObject *  args  )

static

callback for the multiply() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isValid(), and multiply().

staticCallback_multVec()

PyObject * PlacementPy::staticCallback_multVec ( PyObject *  self, PyObject *  args  )

static

callback for the multVec() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isValid(), and multVec().

staticCallback_setBase()

int PlacementPy::staticCallback_setBase ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Base attribute

References Base::BaseExceptionFreeCADError, Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), and setBase().

staticCallback_setRotation()

int PlacementPy::staticCallback_setRotation ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Rotation attribute

References Base::BaseExceptionFreeCADError, Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), and setRotation().

staticCallback_toMatrix()

PyObject * PlacementPy::staticCallback_toMatrix ( PyObject *  self, PyObject *  args  )

static

callback for the toMatrix() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isValid(), and toMatrix().

toMatrix()

PyObject * PlacementPy::toMatrix

(

PyObject *

args

)

implementer for the toMatrix() method

References getPlacementPtr(), and Base::Placement::toMatrix().

Referenced by staticCallback_toMatrix().

Member Data Documentation

GetterSetter

PyGetSetDef PlacementPy::GetterSetter

static

Initial value:

= {
    {"Base",
        (getter) staticCallback_getBase,
        (setter) staticCallback_setBase, 
        "Vector to the Base Position of the Placement",
        NULL
    },
    {"Rotation",
        (getter) staticCallback_getRotation,
        (setter) staticCallback_setRotation, 
        "Orientation of the placement expressed as rotation",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of PlacementPy.

Methods

PyMethodDef PlacementPy::Methods

static

Methods structure of PlacementPy.

Type

PyTypeObject PlacementPy::Type

static

Type structure of PlacementPy.

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), PathSimulator::PathSimPy::ApplyCommand(), ArchSite.Compass::buildCoordinates(), Attacher::AttachEnginePy::calculateAttachedPlacement(), App::FunctionExpression::evaluate(), ArchComponent.Component::execute(), DraftLayer.LayerContainer::execute(), Gui::ViewProviderLink::initDraggingPlacement(), Robot::TrajectoryPy::insertWaypoints(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), Base::AxisPy::multiply(), multiply(), Base::MatrixPy::number_multiply_handler(), draftobjects.draft_annotation.DraftAnnotation::onDocumentRestored(), Robot::WaypointPy::PyInit(), Path::CommandPy::PyInit(), PyInit(), richCompare(), Part::GeometryPy::rotate(), Attacher::AttachEnginePy::setAttachmentOffset(), Gui::ViewProviderLinkPy::setDraggingPlacement(), Base::CoordinateSystemPy::setPlacement(), Data::ComplexGeoDataPy::setPlacement(), Path::CommandPy::setPlacement(), Robot::WaypointPy::setPos(), ArchReference.ArchReference::setProperties(), DraftLayer.Layer::setProperties(), Fem::PropertyFemMesh::setPyObject(), App::PropertyPlacement::setPyObject(), Robot::Robot6AxisPy::setTcp(), Fem::FemMeshPy::setTransform(), Gui::ViewProviderPy::setTransformation(), Gui::View3DInventorPy::toggleClippingPlane(), Path::CommandPy::transform(), Base::CoordinateSystemPy::transform(), and Gui::View3DInventorPy::viewPosition().

---

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

• build/webdoc/src/Base/PlacementPy.h
• src/Base/PlacementPyImp.cpp
• build/webdoc/src/Base/PlacementPy.cpp