The python export class for CoordinateSystem. More...

#include <CoordinateSystemPy.h>

Public Types

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

Public Member Functions

 CoordinateSystemPy (CoordinateSystem *pcObject, PyTypeObject *T=&Type)
 
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
 
- Public Member Functions inherited from Base::PyObjectBase
PyObjectBaseDecRef (void)
 decref method wrapper (see python extending manual) More...
 
PyObjectBaseIncRef (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 PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
- 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 CoordinateSystemPy. More...
 
static PyMethodDef Methods []
 Methods structure of CoordinateSystemPy. More...
 
static PyTypeObject Type
 Type structure of CoordinateSystemPy. More...
 
- Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
 
static PyTypeObject Type
 Py_Header struct from python.h. More...
 

Protected Member Functions

 ~CoordinateSystemPy ()
 
- Protected Member Functions inherited from Base::PyObjectBase
void setTwinPointer (void *ptr)
 Overrides the pointer to the twin object. More...
 
virtual ~PyObjectBase ()
 destructor More...
 

callbacks and implementers for the python object methods

PyObjectsetAxes (PyObject *args)
 implementer for the setAxes() method More...
 
PyObjectdisplacement (PyObject *args)
 implementer for the displacement() method More...
 
PyObjecttransformTo (PyObject *args)
 implementer for the transformTo() method More...
 
PyObjecttransform (PyObject *args)
 implementer for the transform() method More...
 
PyObjectsetPlacement (PyObject *args)
 implementer for the setPlacement() method More...
 
static PyObjectstaticCallback_setAxes (PyObject *self, PyObject *args)
 callback for the setAxes() method More...
 
static PyObjectstaticCallback_displacement (PyObject *self, PyObject *args)
 callback for the displacement() method More...
 
static PyObjectstaticCallback_transformTo (PyObject *self, PyObject *args)
 callback for the transformTo() method More...
 
static PyObjectstaticCallback_transform (PyObject *self, PyObject *args)
 callback for the transform() method More...
 
static PyObjectstaticCallback_setPlacement (PyObject *self, PyObject *args)
 callback for the setPlacement() method More...
 

callbacks and implementers for the python object attributes

Py::Object getAxis (void) const
 getter for the Axis attribute More...
 
void setAxis (Py::Object arg)
 setter for the Axis attribute More...
 
Py::Object getXDirection (void) const
 getter for the XDirection attribute More...
 
void setXDirection (Py::Object arg)
 setter for the XDirection attribute More...
 
Py::Object getYDirection (void) const
 getter for the YDirection attribute More...
 
void setYDirection (Py::Object arg)
 setter for the YDirection attribute More...
 
Py::Object getZDirection (void) const
 getter for the ZDirection attribute More...
 
void setZDirection (Py::Object arg)
 setter for the ZDirection attribute More...
 
Py::Object getPosition (void) const
 getter for the Position attribute More...
 
void setPosition (Py::Object arg)
 setter for the Position attribute More...
 
PyObjectgetCustomAttributes (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...
 
CoordinateSystemgetCoordinateSystemPtr (void) const
 getter for the object handled by this class More...
 
static PyObjectstaticCallback_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 PyObjectstaticCallback_getXDirection (PyObject *self, void *closure)
 getter callback for the XDirection attribute More...
 
static int staticCallback_setXDirection (PyObject *self, PyObject *value, void *closure)
 setter callback for the XDirection attribute More...
 
static PyObjectstaticCallback_getYDirection (PyObject *self, void *closure)
 getter callback for the YDirection attribute More...
 
static int staticCallback_setYDirection (PyObject *self, PyObject *value, void *closure)
 setter callback for the YDirection attribute More...
 
static PyObjectstaticCallback_getZDirection (PyObject *self, void *closure)
 getter callback for the ZDirection attribute More...
 
static int staticCallback_setZDirection (PyObject *self, PyObject *value, void *closure)
 setter callback for the ZDirection attribute More...
 
static PyObjectstaticCallback_getPosition (PyObject *self, void *closure)
 getter callback for the Position attribute More...
 
static int staticCallback_setPosition (PyObject *self, PyObject *value, void *closure)
 setter callback for the Position attribute More...
 

Additional Inherited Members

- Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 > StatusBits
 

Detailed Description

The python export class for CoordinateSystem.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~CoordinateSystemPy()

CoordinateSystemPy::~CoordinateSystemPy ( )
protected

◆ CoordinateSystemPy()

CoordinateSystemPy::CoordinateSystemPy ( CoordinateSystem pcObject,
PyTypeObject *  T = &Type 
)

Referenced by PyMake().

Member Function Documentation

◆ displacement()

PyObject * CoordinateSystemPy::displacement ( PyObject args)

◆ getAxis()

Py::Object CoordinateSystemPy::getAxis ( void  ) const

getter for the Axis attribute

References Base::CoordinateSystem::getAxis(), and getCoordinateSystemPtr().

Referenced by staticCallback_getAxis().

◆ getCoordinateSystemPtr()

CoordinateSystem * CoordinateSystemPy::getCoordinateSystemPtr ( void  ) const

◆ getCustomAttributes()

PyObject * CoordinateSystemPy::getCustomAttributes ( const char *  attr) const

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

◆ getPosition()

Py::Object CoordinateSystemPy::getPosition ( void  ) const

getter for the Position attribute

References getCoordinateSystemPtr().

Referenced by staticCallback_getPosition().

◆ GetType()

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

Reimplemented from Base::PyObjectBase.

◆ getXDirection()

Py::Object CoordinateSystemPy::getXDirection ( void  ) const

getter for the XDirection attribute

References getCoordinateSystemPtr().

Referenced by staticCallback_getXDirection().

◆ getYDirection()

Py::Object CoordinateSystemPy::getYDirection ( void  ) const

getter for the YDirection attribute

References getCoordinateSystemPtr().

Referenced by staticCallback_getYDirection().

◆ getZDirection()

Py::Object CoordinateSystemPy::getZDirection ( void  ) const

getter for the ZDirection attribute

References getCoordinateSystemPtr().

Referenced by staticCallback_getZDirection().

◆ PyInit()

int CoordinateSystemPy::PyInit ( PyObject ,
PyObject  
)
virtual

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

Reimplemented from Base::PyObjectBase.

◆ PyMake()

PyObject * CoordinateSystemPy::PyMake ( struct _typeobject *  ,
PyObject ,
PyObject  
)
static

References CoordinateSystemPy().

◆ representation()

◆ setAxes()

PyObject * CoordinateSystemPy::setAxes ( PyObject args)

◆ setAxis()

void CoordinateSystemPy::setAxis ( Py::Object  arg)

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ setPlacement()

PyObject * CoordinateSystemPy::setPlacement ( PyObject args)

◆ setPosition()

void CoordinateSystemPy::setPosition ( Py::Object  arg)

setter for the Position attribute

References getCoordinateSystemPtr(), Base::CoordinateSystem::setPosition(), and Base::toVector().

Referenced by staticCallback_setPosition().

◆ setXDirection()

void CoordinateSystemPy::setXDirection ( Py::Object  arg)

setter for the XDirection attribute

References getCoordinateSystemPtr(), Base::CoordinateSystem::setXDirection(), and Base::toVector().

Referenced by staticCallback_setXDirection().

◆ setYDirection()

void CoordinateSystemPy::setYDirection ( Py::Object  arg)

setter for the YDirection attribute

References getCoordinateSystemPtr(), Base::CoordinateSystem::setYDirection(), and Base::toVector().

Referenced by staticCallback_setYDirection().

◆ setZDirection()

void CoordinateSystemPy::setZDirection ( Py::Object  arg)

setter for the ZDirection attribute

References getCoordinateSystemPtr(), Base::CoordinateSystem::setZDirection(), and Base::toVector().

Referenced by staticCallback_setZDirection().

◆ staticCallback_displacement()

PyObject * CoordinateSystemPy::staticCallback_displacement ( PyObject self,
PyObject args 
)
static

◆ staticCallback_getAxis()

PyObject * CoordinateSystemPy::staticCallback_getAxis ( PyObject self,
void *  closure 
)
static

getter callback for the Axis attribute

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

◆ staticCallback_getPosition()

PyObject * CoordinateSystemPy::staticCallback_getPosition ( PyObject self,
void *  closure 
)
static

getter callback for the Position attribute

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

◆ staticCallback_getXDirection()

PyObject * CoordinateSystemPy::staticCallback_getXDirection ( PyObject self,
void *  closure 
)
static

getter callback for the XDirection attribute

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

◆ staticCallback_getYDirection()

PyObject * CoordinateSystemPy::staticCallback_getYDirection ( PyObject self,
void *  closure 
)
static

getter callback for the YDirection attribute

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

◆ staticCallback_getZDirection()

PyObject * CoordinateSystemPy::staticCallback_getZDirection ( PyObject self,
void *  closure 
)
static

getter callback for the ZDirection attribute

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

◆ staticCallback_setAxes()

PyObject * CoordinateSystemPy::staticCallback_setAxes ( PyObject self,
PyObject args 
)
static

◆ staticCallback_setAxis()

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

◆ staticCallback_setPlacement()

PyObject * CoordinateSystemPy::staticCallback_setPlacement ( PyObject self,
PyObject args 
)
static

◆ staticCallback_setPosition()

int CoordinateSystemPy::staticCallback_setPosition ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setXDirection()

int CoordinateSystemPy::staticCallback_setXDirection ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setYDirection()

int CoordinateSystemPy::staticCallback_setYDirection ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setZDirection()

int CoordinateSystemPy::staticCallback_setZDirection ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_transform()

PyObject * CoordinateSystemPy::staticCallback_transform ( PyObject self,
PyObject args 
)
static

◆ staticCallback_transformTo()

PyObject * CoordinateSystemPy::staticCallback_transformTo ( PyObject self,
PyObject args 
)
static

◆ transform()

◆ transformTo()

PyObject * CoordinateSystemPy::transformTo ( PyObject args)

Member Data Documentation

◆ GetterSetter

PyGetSetDef CoordinateSystemPy::GetterSetter
static

Attribute structure of CoordinateSystemPy.

◆ Methods

PyMethodDef CoordinateSystemPy::Methods
static
Initial value:
= {
{"setAxes",
reinterpret_cast<PyCFunction>( staticCallback_setAxes ),
METH_VARARGS,
"setAxes(Axis or Vector z, Vector x)\nSet axis or z direction and x direction"
},
{"displacement",
reinterpret_cast<PyCFunction>( staticCallback_displacement ),
METH_VARARGS,
"displacement(CoordinateSystem)\nComputes the placement from this to the passed coordinate system"
},
{"transformTo",
reinterpret_cast<PyCFunction>( staticCallback_transformTo ),
METH_VARARGS,
"transformTo(Vector)\nComputes the coordinates of the point in coordinates of this system\n "
},
{"transform",
reinterpret_cast<PyCFunction>( staticCallback_transform ),
METH_VARARGS,
"transform(Rotation or Placement)\nApplies the rotation or placement on this coordinate system\n "
},
{"setPlacement",
reinterpret_cast<PyCFunction>( staticCallback_setPlacement ),
METH_VARARGS,
"setPlacment(Placement)\nSet placement to the coordinate system.\n "
},
{NULL, NULL, 0, NULL}
}
static PyObject * staticCallback_setAxes(PyObject *self, PyObject *args)
callback for the setAxes() method
Definition: CoordinateSystemPy.cpp:160
static PyObject * staticCallback_transformTo(PyObject *self, PyObject *args)
callback for the transformTo() method
Definition: CoordinateSystemPy.cpp:289
static PyObject * staticCallback_displacement(PyObject *self, PyObject *args)
callback for the displacement() method
Definition: CoordinateSystemPy.cpp:228
static PyObject * staticCallback_transform(PyObject *self, PyObject *args)
callback for the transform() method
Definition: CoordinateSystemPy.cpp:357
static PyObject * staticCallback_setPlacement(PyObject *self, PyObject *args)
callback for the setPlacement() method
Definition: CoordinateSystemPy.cpp:425

Methods structure of CoordinateSystemPy.

◆ Type


The documentation for this class was generated from the following files:
  • Sources/FreeCAD-SourceDocs/src/Base/CoordinateSystemPy.h
  • Sources/FreeCAD/src/Base/CoordinateSystemPyImp.cpp
  • Sources/FreeCAD-SourceDocs/src/Base/CoordinateSystemPy.cpp