Base::RotationPy Class Reference

The python export class for Rotation. More...

#include <RotationPy.h>

Public Types
typedef Rotation *	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)
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
	RotationPy (Rotation *pcObject, PyTypeObject *T=&Type)
additional declarations and methods for the wrapper class
	RotationPy (const Rotation &mat, PyTypeObject *T=&Type)
Rotation	value () 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 RotationPy. More...
static PyMethodDef	Methods []
	Methods structure of RotationPy. More...
static PyTypeObject	Type
	Type structure of RotationPy. More...
Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef	Methods []
static PyTypeObject	Type
	Py_Header struct from python.h. More...

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

callbacks and implementers for the python object methods
static PyObject *	staticCallback_invert (PyObject *self, PyObject *args)
	callback for the invert() method More...
static PyObject *	staticCallback_inverted (PyObject *self, PyObject *args)
	callback for the inverted() method More...
static PyObject *	staticCallback_isSame (PyObject *self, PyObject *args)
	callback for the isSame() 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_toEuler (PyObject *self, PyObject *args)
	callback for the toEuler() method More...
static PyObject *	staticCallback_isNull (PyObject *self, PyObject *args)
	callback for the isNull() method More...
static PyObject *	staticCallback_isIdentity (PyObject *self, PyObject *args)
	callback for the isIdentity() method More...
PyObject *	invert (PyObject *args)
	implementer for the invert() method More...
PyObject *	inverted (PyObject *args)
	implementer for the inverted() method More...
PyObject *	isSame (PyObject *args)
	implementer for the isSame() method More...
PyObject *	multiply (PyObject *args)
	implementer for the multiply() method More...
PyObject *	multVec (PyObject *args)
	implementer for the multVec() method More...
PyObject *	toEuler (PyObject *args)
	implementer for the toEuler() method More...
PyObject *	isNull (PyObject *args)
	implementer for the isNull() method More...
PyObject *	isIdentity (PyObject *args)
	implementer for the isIdentity() method More...

callbacks and implementers for the python object attributes
static PyObject *	staticCallback_getQ (PyObject *self, void *closure)
	getter callback for the Q attribute More...
static int	staticCallback_setQ (PyObject *self, PyObject *value, void *closure)
	setter callback for the Q attribute More...
static PyObject *	staticCallback_getAxis (PyObject *self, void *closure)
	getter callback for the Axis attribute More...
static int	staticCallback_setAxis (PyObject *self, PyObject *value, void *closure)
	setter callback for the Axis attribute More...
static PyObject *	staticCallback_getAngle (PyObject *self, void *closure)
	getter callback for the Angle attribute More...
static int	staticCallback_setAngle (PyObject *self, PyObject *value, void *closure)
	setter callback for the Angle attribute More...
Py::Tuple	getQ (void) const
	getter for the Q attribute More...
void	setQ (Py::Tuple arg)
	setter for the Q attribute More...
Py::Object	getAxis (void) const
	getter for the Axis attribute More...
void	setAxis (Py::Object arg)
	setter for the Axis attribute More...
Py::Float	getAngle (void) const
	getter for the Angle attribute More...
void	setAngle (Py::Float arg)
	setter for the Angle 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...
Rotation *	getRotationPtr (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 Rotation.

Member Typedef Documentation

PointerType

typedef Rotation* Base::RotationPy::PointerType

Constructor & Destructor Documentation

~RotationPy()

RotationPy::~RotationPy ( )

protected

RotationPy() [1/2]

RotationPy::RotationPy	(	Rotation *	pcObject,
		PyTypeObject *	T = &Type
	)

Referenced by inverted(), multiply(), and PyMake().

RotationPy() [2/2]

Base::RotationPy::RotationPy	(	const Rotation &	mat,
		PyTypeObject *	T = &Type
	)

Member Function Documentation

getAngle()

Py::Float RotationPy::getAngle

(

void

)

const

getter for the Angle attribute

References DraftVecUtils::angle(), getRotationPtr(), and Base::Rotation::getValue().

Referenced by PathScripts.PathDressupDogbone.Chord::getAngleXY(), draftguitools.gui_trackers.arcTracker::setEndPoint(), draftguitools.gui_trackers.arcTracker::setStartPoint(), and staticCallback_getAngle().

getAxis()

Py::Object RotationPy::getAxis

(

void

)

const

getter for the Axis attribute

References DraftVecUtils::angle(), getRotationPtr(), and Base::Rotation::getValue().

Referenced by staticCallback_getAxis().

getCustomAttributes()

PyObject * RotationPy::getCustomAttributes

(

const char *

attr

)

const

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

References getRotationPtr(), Base::Rotation::getValue(), and Base::Rotation::getYawPitchRoll().

getQ()

Py::Tuple RotationPy::getQ

(

void

)

const

getter for the Q attribute

References getRotationPtr(), and Base::Rotation::getValue().

Referenced by staticCallback_getQ().

getRotationPtr()

Rotation * RotationPy::getRotationPtr

(

void

)

const

getter for the object handled by this class

Referenced by getAngle(), getAxis(), getCustomAttributes(), getQ(), invert(), inverted(), isIdentity(), isNull(), isSame(), multiply(), multVec(), PyInit(), richCompare(), setAngle(), setAxis(), setCustomAttributes(), setQ(), and toEuler().

GetType()

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

virtual

Reimplemented from Base::PyObjectBase.

invert()

PyObject * RotationPy::invert

(

PyObject *

args

)

implementer for the invert() method

References getRotationPtr(), and Base::Rotation::invert().

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

inverted()

PyObject * RotationPy::inverted

(

PyObject *

args

)

implementer for the inverted() method

References getRotationPtr(), Base::Rotation::inverse(), and RotationPy().

Referenced by staticCallback_inverted().

isIdentity()

PyObject * RotationPy::isIdentity

(

PyObject *

args

)

implementer for the isIdentity() method

References getRotationPtr(), and Base::Rotation::isIdentity().

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

isNull()

PyObject * RotationPy::isNull

(

PyObject *

args

)

implementer for the isNull() method

References getRotationPtr(), and Base::Rotation::isNull().

Referenced by staticCallback_isNull().

isSame()

PyObject * RotationPy::isSame

(

PyObject *

args

)

implementer for the isSame() method

References getRotationPtr(), Base::Rotation::isSame(), and Type.

Referenced by staticCallback_isSame().

multiply()

PyObject * RotationPy::multiply

(

PyObject *

args

)

implementer for the multiply() method

References getRotationPtr(), RotationPy(), and Type.

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

multVec()

PyObject * RotationPy::multVec

(

PyObject *

args

)

implementer for the multVec() method

References getRotationPtr(), Base::Rotation::multVec(), Base::VectorPy::Type, and value().

Referenced by staticCallback_multVec().

PyInit()

int RotationPy::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, getRotationPtr(), Base::Rotation::getValue(), Base::Rotation::makeRotationByAxes(), Base::Rotation::setValue(), Base::Rotation::setYawPitchRoll(), Type, Base::MatrixPy::Type, Base::VectorPy::Type, and value().

PyMake()

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

static

References RotationPy().

representation()

std::string RotationPy::representation

(

void

)

const

References Base::Rotation::getValue().

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 * RotationPy::richCompare ( PyObject *  v, PyObject *  w, int  op  )

static

References getRotationPtr(), and Type.

setAngle()

void RotationPy::setAngle

(

Py::Float

arg

)

setter for the Angle attribute

References DraftVecUtils::angle(), Base::Rotation::getRawValue(), getRotationPtr(), and Base::Rotation::setValue().

Referenced by staticCallback_setAngle().

setAxis()

void RotationPy::setAxis

(

Py::Object

arg

)

setter for the Axis attribute

References DraftVecUtils::angle(), getRotationPtr(), Base::Rotation::getValue(), and Base::Rotation::setValue().

Referenced by staticCallback_setAxis().

setCustomAttributes()

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

setter for special attributes (e.g.

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

References getRotationPtr(), Base::Rotation::getYawPitchRoll(), Base::Rotation::setValue(), Base::Rotation::setYawPitchRoll(), Base::MatrixPy::Type, and Base::VectorPy::Type.

setQ()

void RotationPy::setQ

(

Py::Tuple

arg

)

setter for the Q attribute

References getRotationPtr(), and Base::Rotation::setValue().

Referenced by staticCallback_setQ().

staticCallback_getAngle()

PyObject * RotationPy::staticCallback_getAngle ( PyObject *  self, void *  closure  )

static

getter callback for the Angle attribute

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

staticCallback_getAxis()

PyObject * RotationPy::staticCallback_getAxis ( PyObject *  self, void *  closure  )

static

getter callback for the Axis attribute

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

staticCallback_getQ()

PyObject * RotationPy::staticCallback_getQ ( PyObject *  self, void *  closure  )

static

getter callback for the Q attribute

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

staticCallback_invert()

PyObject * RotationPy::staticCallback_invert ( PyObject *  self, PyObject *  args  )

static

callback for the invert() method

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

staticCallback_inverted()

PyObject * RotationPy::staticCallback_inverted ( PyObject *  self, PyObject *  args  )

static

callback for the inverted() method

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

staticCallback_isIdentity()

PyObject * RotationPy::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_isNull()

PyObject * RotationPy::staticCallback_isNull ( PyObject *  self, PyObject *  args  )

static

callback for the isNull() method

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

staticCallback_isSame()

PyObject * RotationPy::staticCallback_isSame ( PyObject *  self, PyObject *  args  )

static

callback for the isSame() method

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

staticCallback_multiply()

PyObject * RotationPy::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 * RotationPy::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_setAngle()

int RotationPy::staticCallback_setAngle ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Angle attribute

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

staticCallback_setAxis()

int RotationPy::staticCallback_setAxis ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Axis attribute

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

staticCallback_setQ()

int RotationPy::staticCallback_setQ ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Q attribute

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

staticCallback_toEuler()

PyObject * RotationPy::staticCallback_toEuler ( PyObject *  self, PyObject *  args  )

static

callback for the toEuler() method

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

toEuler()

PyObject * RotationPy::toEuler

(

PyObject *

args

)

implementer for the toEuler() method

References getRotationPtr(), and Base::Rotation::getYawPitchRoll().

Referenced by staticCallback_toEuler().

value()

Rotation Base::RotationPy::value

(

)

const

Referenced by Mod.PartDesign.WizardShaft.SegmentFunction.SegmentFunction::evaluate(), Mod.PartDesign.WizardShaft.SegmentFunction.IntervalFunction::lowervalue(), multVec(), and PyInit().

Member Data Documentation

GetterSetter

PyGetSetDef RotationPy::GetterSetter

static

Initial value:

= {
    {"Q",
        (getter) staticCallback_getQ,
        (setter) staticCallback_setQ, 
        "The rotation elements (as quaternion)",
        NULL
    },
    {"Axis",
        (getter) staticCallback_getAxis,
        (setter) staticCallback_setAxis, 
        "The rotation axis of the quaternion",
        NULL
    },
    {"Angle",
        (getter) staticCallback_getAngle,
        (setter) staticCallback_setAngle, 
        "The rotation angle of the quaternion",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of RotationPy.

Methods

PyMethodDef RotationPy::Methods

static

Methods structure of RotationPy.

Type

PyTypeObject RotationPy::Type

static

Type structure of RotationPy.

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), App::FunctionExpression::evaluate(), ArchComponent.Component::execute(), DraftLayer.LayerContainer::execute(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), isSame(), multiply(), Base::MatrixPy::number_multiply_handler(), draftobjects.draft_annotation.DraftAnnotation::onDocumentRestored(), Base::PlacementPy::PyInit(), PyInit(), richCompare(), Gui::View3DInventorPy::setCameraOrientation(), ArchReference.ArchReference::setProperties(), DraftLayer.Layer::setProperties(), and Base::CoordinateSystemPy::transform().

---

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

• build/webdoc/src/Base/RotationPy.h
• src/Base/RotationPyImp.cpp
• build/webdoc/src/Base/RotationPy.cpp