TechDraw::CosmeticVertexPy Class Reference

The python export class for CosmeticVertex. More...

#include <CosmeticVertexPy.h>

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

Public Member Functions
	CosmeticVertexPy (CosmeticVertex *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
callbacks and implementers for the python object attributes
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...
CosmeticVertex *	getCosmeticVertexPtr (void) const
	getter for the object handled by this class More...
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 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 CosmeticVertexPy. More...
static PyMethodDef	Methods []
	Methods structure of CosmeticVertexPy. More...
static PyTypeObject	Type
	Type structure of CosmeticVertexPy. More...
Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef	Methods []
static PyTypeObject	Type
	Py_Header struct from python.h. More...

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

callbacks and implementers for the python object methods
PyObject *	clone (PyObject *args)
	implementer for the clone() method More...
PyObject *	copy (PyObject *args)
	implementer for the copy() method More...
static PyObject *	staticCallback_clone (PyObject *self, PyObject *args)
	callback for the clone() method More...
static PyObject *	staticCallback_copy (PyObject *self, PyObject *args)
	callback for the copy() method More...

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

Detailed Description

The python export class for CosmeticVertex.

Member Typedef Documentation

PointerType

typedef CosmeticVertex* TechDraw::CosmeticVertexPy::PointerType

Constructor & Destructor Documentation

~CosmeticVertexPy()

CosmeticVertexPy::~CosmeticVertexPy ( )

protected

CosmeticVertexPy()

CosmeticVertexPy::CosmeticVertexPy	(	CosmeticVertex *	pcObject,
		PyTypeObject *	T = &Type
	)

Member Function Documentation

clone()

PyObject * CosmeticVertexPy::clone

(

PyObject *

args

)

implementer for the clone() method

References TechDraw::CosmeticVertex::clone(), getCosmeticVertexPtr(), and GetType().

Referenced by ArchPanel.CommandPanelSheet::Activated(), and staticCallback_clone().

copy()

PyObject * CosmeticVertexPy::copy

(

PyObject *

args

)

implementer for the copy() method

References TechDraw::CosmeticVertex::copy(), getCosmeticVertexPtr(), and GetType().

Referenced by staticCallback_copy().

getCosmeticVertexPtr()

CosmeticVertex * CosmeticVertexPy::getCosmeticVertexPtr

(

void

)

const

getter for the object handled by this class

Referenced by clone(), copy(), TechDraw::DrawViewPartPy::removeCosmeticVertex(), and TechDraw::PropertyCosmeticVertexList::setPyObject().

getCustomAttributes()

PyObject * CosmeticVertexPy::getCustomAttributes

(

const char *

attr

)

const

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

GetType()

virtual PyTypeObject* TechDraw::CosmeticVertexPy::GetType ( void  )

virtual

Reimplemented from Base::PyObjectBase.

Referenced by clone(), and copy().

PyInit()

int CosmeticVertexPy::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 * CosmeticVertexPy::PyMake ( struct _typeobject *  , PyObject *  , PyObject *    )

static

representation()

std::string CosmeticVertexPy::representation

(

void

)

const

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().

setCustomAttributes()

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

setter for special attributes (e.g.

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

staticCallback_clone()

PyObject * CosmeticVertexPy::staticCallback_clone ( PyObject *  self, PyObject *  args  )

static

callback for the clone() method

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

staticCallback_copy()

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

static

callback for the copy() method

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

Member Data Documentation

GetterSetter

PyGetSetDef CosmeticVertexPy::GetterSetter

static

Initial value:

= {
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of CosmeticVertexPy.

Methods

PyMethodDef CosmeticVertexPy::Methods

static

Initial value:

= {
    {"clone",
        reinterpret_cast<PyCFunction>( staticCallback_clone ),
        METH_VARARGS,
        "Create a clone of this CosmeticVertex"
    },
    {"copy",
        reinterpret_cast<PyCFunction>( staticCallback_copy ),
        METH_VARARGS,
        "Create a copy of this CosmeticVertex"
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of CosmeticVertexPy.

Type

PyTypeObject CosmeticVertexPy::Type

static

Type structure of CosmeticVertexPy.

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), and TechDraw::DrawViewPartPy::removeCosmeticVertex().

---

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

• build/webdoc/src/Mod/TechDraw/App/CosmeticVertexPy.h
• src/Mod/TechDraw/App/CosmeticVertexPyImp.cpp
• build/webdoc/src/Mod/TechDraw/App/CosmeticVertexPy.cpp