The python export class for BoundBox. More...

#include <BoundBoxPy.h>

Public Types

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

Public Member Functions

 BoundBoxPy (BoundBox3d *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 BoundBoxPy. More...
 
static PyMethodDef Methods []
 Methods structure of BoundBoxPy. More...
 
static PyTypeObject Type
 Type structure of BoundBoxPy. More...
 
- Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
 
static PyTypeObject Type
 Py_Header struct from python.h. More...
 

Protected Member Functions

 ~BoundBoxPy ()
 
- 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

PyObjectsetVoid (PyObject *args)
 implementer for the setVoid() method More...
 
PyObjectisValid (PyObject *args)
 implementer for the isValid() method More...
 
PyObjectadd (PyObject *args)
 implementer for the add() method More...
 
PyObjectgetPoint (PyObject *args)
 implementer for the getPoint() method More...
 
PyObjectgetEdge (PyObject *args)
 implementer for the getEdge() method More...
 
PyObjectclosestPoint (PyObject *args)
 implementer for the closestPoint() method More...
 
PyObjectintersect (PyObject *args)
 implementer for the intersect() method More...
 
PyObjectintersected (PyObject *args)
 implementer for the intersected() method More...
 
PyObjectunited (PyObject *args)
 implementer for the united() method More...
 
PyObjectenlarge (PyObject *args)
 implementer for the enlarge() method More...
 
PyObjectgetIntersectionPoint (PyObject *args)
 implementer for the getIntersectionPoint() method More...
 
PyObjectmove (PyObject *args)
 implementer for the move() method More...
 
PyObjectscale (PyObject *args)
 implementer for the scale() method More...
 
PyObjecttransformed (PyObject *args)
 implementer for the transformed() method More...
 
PyObjectisCutPlane (PyObject *args)
 implementer for the isCutPlane() method More...
 
PyObjectisInside (PyObject *args)
 implementer for the isInside() method More...
 
static PyObjectstaticCallback_setVoid (PyObject *self, PyObject *args)
 callback for the setVoid() method More...
 
static PyObjectstaticCallback_isValid (PyObject *self, PyObject *args)
 callback for the isValid() method More...
 
static PyObjectstaticCallback_add (PyObject *self, PyObject *args)
 callback for the add() method More...
 
static PyObjectstaticCallback_getPoint (PyObject *self, PyObject *args)
 callback for the getPoint() method More...
 
static PyObjectstaticCallback_getEdge (PyObject *self, PyObject *args)
 callback for the getEdge() method More...
 
static PyObjectstaticCallback_closestPoint (PyObject *self, PyObject *args)
 callback for the closestPoint() method More...
 
static PyObjectstaticCallback_intersect (PyObject *self, PyObject *args)
 callback for the intersect() method More...
 
static PyObjectstaticCallback_intersected (PyObject *self, PyObject *args)
 callback for the intersected() method More...
 
static PyObjectstaticCallback_united (PyObject *self, PyObject *args)
 callback for the united() method More...
 
static PyObjectstaticCallback_enlarge (PyObject *self, PyObject *args)
 callback for the enlarge() method More...
 
static PyObjectstaticCallback_getIntersectionPoint (PyObject *self, PyObject *args)
 callback for the getIntersectionPoint() method More...
 
static PyObjectstaticCallback_move (PyObject *self, PyObject *args)
 callback for the move() method More...
 
static PyObjectstaticCallback_scale (PyObject *self, PyObject *args)
 callback for the scale() method More...
 
static PyObjectstaticCallback_transformed (PyObject *self, PyObject *args)
 callback for the transformed() method More...
 
static PyObjectstaticCallback_isCutPlane (PyObject *self, PyObject *args)
 callback for the isCutPlane() method More...
 
static PyObjectstaticCallback_isInside (PyObject *self, PyObject *args)
 callback for the isInside() method More...
 

callbacks and implementers for the python object attributes

Py::Object getCenter (void) const
 getter for the Center attribute More...
 
Py::Float getXMax (void) const
 getter for the XMax attribute More...
 
void setXMax (Py::Float arg)
 setter for the XMax attribute More...
 
Py::Float getYMax (void) const
 getter for the YMax attribute More...
 
void setYMax (Py::Float arg)
 setter for the YMax attribute More...
 
Py::Float getZMax (void) const
 getter for the ZMax attribute More...
 
void setZMax (Py::Float arg)
 setter for the ZMax attribute More...
 
Py::Float getXMin (void) const
 getter for the XMin attribute More...
 
void setXMin (Py::Float arg)
 setter for the XMin attribute More...
 
Py::Float getYMin (void) const
 getter for the YMin attribute More...
 
void setYMin (Py::Float arg)
 setter for the YMin attribute More...
 
Py::Float getZMin (void) const
 getter for the ZMin attribute More...
 
void setZMin (Py::Float arg)
 setter for the ZMin attribute More...
 
Py::Float getXLength (void) const
 getter for the XLength attribute More...
 
Py::Float getYLength (void) const
 getter for the YLength attribute More...
 
Py::Float getZLength (void) const
 getter for the ZLength attribute More...
 
Py::Float getDiagonalLength (void) const
 getter for the DiagonalLength 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...
 
BoundBox3dgetBoundBoxPtr (void) const
 getter for the object handled by this class More...
 
static PyObjectstaticCallback_getCenter (PyObject *self, void *closure)
 getter callback for the Center attribute More...
 
static int staticCallback_setCenter (PyObject *self, PyObject *value, void *closure)
 setter callback for the Center attribute More...
 
static PyObjectstaticCallback_getXMax (PyObject *self, void *closure)
 getter callback for the XMax attribute More...
 
static int staticCallback_setXMax (PyObject *self, PyObject *value, void *closure)
 setter callback for the XMax attribute More...
 
static PyObjectstaticCallback_getYMax (PyObject *self, void *closure)
 getter callback for the YMax attribute More...
 
static int staticCallback_setYMax (PyObject *self, PyObject *value, void *closure)
 setter callback for the YMax attribute More...
 
static PyObjectstaticCallback_getZMax (PyObject *self, void *closure)
 getter callback for the ZMax attribute More...
 
static int staticCallback_setZMax (PyObject *self, PyObject *value, void *closure)
 setter callback for the ZMax attribute More...
 
static PyObjectstaticCallback_getXMin (PyObject *self, void *closure)
 getter callback for the XMin attribute More...
 
static int staticCallback_setXMin (PyObject *self, PyObject *value, void *closure)
 setter callback for the XMin attribute More...
 
static PyObjectstaticCallback_getYMin (PyObject *self, void *closure)
 getter callback for the YMin attribute More...
 
static int staticCallback_setYMin (PyObject *self, PyObject *value, void *closure)
 setter callback for the YMin attribute More...
 
static PyObjectstaticCallback_getZMin (PyObject *self, void *closure)
 getter callback for the ZMin attribute More...
 
static int staticCallback_setZMin (PyObject *self, PyObject *value, void *closure)
 setter callback for the ZMin attribute More...
 
static PyObjectstaticCallback_getXLength (PyObject *self, void *closure)
 getter callback for the XLength attribute More...
 
static int staticCallback_setXLength (PyObject *self, PyObject *value, void *closure)
 setter callback for the XLength attribute More...
 
static PyObjectstaticCallback_getYLength (PyObject *self, void *closure)
 getter callback for the YLength attribute More...
 
static int staticCallback_setYLength (PyObject *self, PyObject *value, void *closure)
 setter callback for the YLength attribute More...
 
static PyObjectstaticCallback_getZLength (PyObject *self, void *closure)
 getter callback for the ZLength attribute More...
 
static int staticCallback_setZLength (PyObject *self, PyObject *value, void *closure)
 setter callback for the ZLength attribute More...
 
static PyObjectstaticCallback_getDiagonalLength (PyObject *self, void *closure)
 getter callback for the DiagonalLength attribute More...
 
static int staticCallback_setDiagonalLength (PyObject *self, PyObject *value, void *closure)
 setter callback for the DiagonalLength attribute More...
 

Additional Inherited Members

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

Detailed Description

The python export class for BoundBox.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~BoundBoxPy()

BoundBoxPy::~BoundBoxPy ( )
protected

◆ BoundBoxPy()

BoundBoxPy::BoundBoxPy ( BoundBox3d pcObject,
PyTypeObject *  T = &Type 
)

Referenced by PyMake().

Member Function Documentation

◆ add()

PyObject * BoundBoxPy::add ( PyObject args)

implementer for the add() method

References Base::BoundBox3< _Precision >::Add(), getBoundBoxPtr(), Type, and Base::VectorPy::Type.

Referenced by staticCallback_add().

◆ closestPoint()

◆ enlarge()

PyObject * BoundBoxPy::enlarge ( PyObject args)

implementer for the enlarge() method

References Base::BoundBox3< _Precision >::Enlarge(), and getBoundBoxPtr().

Referenced by staticCallback_enlarge().

◆ getBoundBoxPtr()

◆ getCenter()

Py::Object BoundBoxPy::getCenter ( void  ) const

getter for the Center attribute

References getBoundBoxPtr().

Referenced by staticCallback_getCenter().

◆ getCustomAttributes()

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

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

◆ getDiagonalLength()

Py::Float BoundBoxPy::getDiagonalLength ( void  ) const

getter for the DiagonalLength attribute

References getBoundBoxPtr().

Referenced by staticCallback_getDiagonalLength().

◆ getEdge()

PyObject * BoundBoxPy::getEdge ( PyObject args)

implementer for the getEdge() method

References Base::BoundBox3< _Precision >::CalcEdge(), and getBoundBoxPtr().

Referenced by staticCallback_getEdge().

◆ getIntersectionPoint()

◆ getPoint()

◆ GetType()

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

Reimplemented from Base::PyObjectBase.

◆ getXLength()

Py::Float BoundBoxPy::getXLength ( void  ) const

getter for the XLength attribute

References getBoundBoxPtr().

Referenced by staticCallback_getXLength().

◆ getXMax()

Py::Float BoundBoxPy::getXMax ( void  ) const

getter for the XMax attribute

References getBoundBoxPtr().

Referenced by staticCallback_getXMax().

◆ getXMin()

Py::Float BoundBoxPy::getXMin ( void  ) const

getter for the XMin attribute

References getBoundBoxPtr().

Referenced by staticCallback_getXMin().

◆ getYLength()

Py::Float BoundBoxPy::getYLength ( void  ) const

getter for the YLength attribute

References getBoundBoxPtr().

Referenced by staticCallback_getYLength().

◆ getYMax()

Py::Float BoundBoxPy::getYMax ( void  ) const

getter for the YMax attribute

References getBoundBoxPtr().

Referenced by staticCallback_getYMax().

◆ getYMin()

Py::Float BoundBoxPy::getYMin ( void  ) const

getter for the YMin attribute

References getBoundBoxPtr().

Referenced by staticCallback_getYMin().

◆ getZLength()

Py::Float BoundBoxPy::getZLength ( void  ) const

getter for the ZLength attribute

References getBoundBoxPtr().

Referenced by staticCallback_getZLength().

◆ getZMax()

Py::Float BoundBoxPy::getZMax ( void  ) const

getter for the ZMax attribute

References getBoundBoxPtr().

Referenced by staticCallback_getZMax().

◆ getZMin()

Py::Float BoundBoxPy::getZMin ( void  ) const

getter for the ZMin attribute

References getBoundBoxPtr().

Referenced by staticCallback_getZMin().

◆ intersect()

◆ intersected()

PyObject * BoundBoxPy::intersected ( PyObject args)

◆ isCutPlane()

PyObject * BoundBoxPy::isCutPlane ( PyObject args)

◆ isInside()

PyObject * BoundBoxPy::isInside ( PyObject args)

◆ isValid()

PyObject * BoundBoxPy::isValid ( PyObject args)

implementer for the isValid() method

References getBoundBoxPtr().

◆ move()

◆ PyInit()

◆ PyMake()

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

References BoundBoxPy().

◆ representation()

◆ scale()

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ setVoid()

PyObject * BoundBoxPy::setVoid ( PyObject args)

implementer for the setVoid() method

References getBoundBoxPtr(), and Base::BoundBox3< _Precision >::SetVoid().

Referenced by staticCallback_setVoid().

◆ setXMax()

void BoundBoxPy::setXMax ( Py::Float  arg)

setter for the XMax attribute

References getBoundBoxPtr(), and Base::BoundBox3< _Precision >::MaxX.

Referenced by staticCallback_setXMax().

◆ setXMin()

void BoundBoxPy::setXMin ( Py::Float  arg)

setter for the XMin attribute

References getBoundBoxPtr(), and Base::BoundBox3< _Precision >::MinX.

Referenced by staticCallback_setXMin().

◆ setYMax()

void BoundBoxPy::setYMax ( Py::Float  arg)

setter for the YMax attribute

References getBoundBoxPtr(), and Base::BoundBox3< _Precision >::MaxY.

Referenced by staticCallback_setYMax().

◆ setYMin()

void BoundBoxPy::setYMin ( Py::Float  arg)

setter for the YMin attribute

References getBoundBoxPtr(), and Base::BoundBox3< _Precision >::MinY.

Referenced by staticCallback_setYMin().

◆ setZMax()

void BoundBoxPy::setZMax ( Py::Float  arg)

setter for the ZMax attribute

References getBoundBoxPtr(), and Base::BoundBox3< _Precision >::MaxZ.

Referenced by staticCallback_setZMax().

◆ setZMin()

void BoundBoxPy::setZMin ( Py::Float  arg)

setter for the ZMin attribute

References getBoundBoxPtr(), and Base::BoundBox3< _Precision >::MinZ.

Referenced by staticCallback_setZMin().

◆ staticCallback_add()

◆ staticCallback_closestPoint()

◆ staticCallback_enlarge()

◆ staticCallback_getCenter()

PyObject * BoundBoxPy::staticCallback_getCenter ( PyObject self,
void *  closure 
)
static

getter callback for the Center attribute

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

◆ staticCallback_getDiagonalLength()

PyObject * BoundBoxPy::staticCallback_getDiagonalLength ( PyObject self,
void *  closure 
)
static

getter callback for the DiagonalLength attribute

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

◆ staticCallback_getEdge()

◆ staticCallback_getIntersectionPoint()

◆ staticCallback_getPoint()

◆ staticCallback_getXLength()

PyObject * BoundBoxPy::staticCallback_getXLength ( PyObject self,
void *  closure 
)
static

getter callback for the XLength attribute

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

◆ staticCallback_getXMax()

PyObject * BoundBoxPy::staticCallback_getXMax ( PyObject self,
void *  closure 
)
static

getter callback for the XMax attribute

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

◆ staticCallback_getXMin()

PyObject * BoundBoxPy::staticCallback_getXMin ( PyObject self,
void *  closure 
)
static

getter callback for the XMin attribute

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

◆ staticCallback_getYLength()

PyObject * BoundBoxPy::staticCallback_getYLength ( PyObject self,
void *  closure 
)
static

getter callback for the YLength attribute

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

◆ staticCallback_getYMax()

PyObject * BoundBoxPy::staticCallback_getYMax ( PyObject self,
void *  closure 
)
static

getter callback for the YMax attribute

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

◆ staticCallback_getYMin()

PyObject * BoundBoxPy::staticCallback_getYMin ( PyObject self,
void *  closure 
)
static

getter callback for the YMin attribute

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

◆ staticCallback_getZLength()

PyObject * BoundBoxPy::staticCallback_getZLength ( PyObject self,
void *  closure 
)
static

getter callback for the ZLength attribute

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

◆ staticCallback_getZMax()

PyObject * BoundBoxPy::staticCallback_getZMax ( PyObject self,
void *  closure 
)
static

getter callback for the ZMax attribute

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

◆ staticCallback_getZMin()

PyObject * BoundBoxPy::staticCallback_getZMin ( PyObject self,
void *  closure 
)
static

getter callback for the ZMin attribute

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

◆ staticCallback_intersect()

◆ staticCallback_intersected()

◆ staticCallback_isCutPlane()

◆ staticCallback_isInside()

◆ staticCallback_isValid()

◆ staticCallback_move()

◆ staticCallback_scale()

◆ staticCallback_setCenter()

int BoundBoxPy::staticCallback_setCenter ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Center attribute

References Base::PyObjectBase::isValid().

◆ staticCallback_setDiagonalLength()

int BoundBoxPy::staticCallback_setDiagonalLength ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the DiagonalLength attribute

References Base::PyObjectBase::isValid().

◆ staticCallback_setVoid()

◆ staticCallback_setXLength()

int BoundBoxPy::staticCallback_setXLength ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the XLength attribute

References Base::PyObjectBase::isValid().

◆ staticCallback_setXMax()

int BoundBoxPy::staticCallback_setXMax ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setXMin()

int BoundBoxPy::staticCallback_setXMin ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setYLength()

int BoundBoxPy::staticCallback_setYLength ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the YLength attribute

References Base::PyObjectBase::isValid().

◆ staticCallback_setYMax()

int BoundBoxPy::staticCallback_setYMax ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setYMin()

int BoundBoxPy::staticCallback_setYMin ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setZLength()

int BoundBoxPy::staticCallback_setZLength ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the ZLength attribute

References Base::PyObjectBase::isValid().

◆ staticCallback_setZMax()

int BoundBoxPy::staticCallback_setZMax ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setZMin()

int BoundBoxPy::staticCallback_setZMin ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_transformed()

◆ staticCallback_united()

◆ transformed()

PyObject * BoundBoxPy::transformed ( PyObject args)

◆ united()

PyObject * BoundBoxPy::united ( PyObject args)

implementer for the united() method

References getBoundBoxPtr(), Type, and Base::BoundBox3< _Precision >::United().

Referenced by staticCallback_united().

Member Data Documentation

◆ GetterSetter

PyGetSetDef BoundBoxPy::GetterSetter
static

Attribute structure of BoundBoxPy.

◆ Methods

PyMethodDef BoundBoxPy::Methods
static

Methods structure of BoundBoxPy.

◆ Type


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