pcbnew.SHAPE Class Reference

Inheritance diagram for pcbnew.SHAPE:

Public Member Functions
def	__init__ (self, *args, **kwargs)
"SHAPE *"	Clone (self)
"bool"	IsNull (self)
"bool"	Collide (self, *args)
"BOX2I const"	BBox (self, "int" aClearance=0)
"VECTOR2I"	Centre (self)
"void"	Rotate (self, *args)
"void"	Move (self, "VECTOR2I" aVector)
"bool"	IsSolid (self)
"bool"	Parse (self, "std::stringstream &" aStream)
"std::string const"	Format (self)
Public Member Functions inherited from pcbnew.SHAPE_BASE
def	__init__ (self, "SHAPE_TYPE" aType)
"SHAPE_TYPE"	Type (self)
"wxString"	TypeName (self)
"bool"	HasIndexableSubshapes (self)
"size_t"	GetIndexableSubshapeCount (self)
"void"	GetIndexableSubshapes (self, "std::vector< SHAPE *,std::allocator< SHAPE * > > &" aSubshapes)

Static Public Attributes
	MIN_PRECISION_IU = _pcbnew.SHAPE_MIN_PRECISION_IU

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from pcbnew.SHAPE_BASE
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Proxy of C++ SHAPE class.

Definition at line 4231 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

def pcbnew.SHAPE.__init__	(		self,
		*	aType,
		**	kwargs
	)

__init__(SHAPE_BASE self, SHAPE_TYPE aType) -> SHAPE_BASE

Reimplemented from pcbnew.SHAPE_BASE.

Reimplemented in pcbnew.SHAPE_LINE_CHAIN, pcbnew.SHAPE_POLY_SET, and pcbnew.SHAPE_LINE_CHAIN_BASE.

Definition at line 4236 of file pcbnew.py.

Member Function Documentation

BBox()

"BOX2I const" pcbnew.SHAPE.BBox	(		self,
		"int"	aClearance = 0
	)

BBox(SHAPE self, int aClearance=0) -> BOX2I const

Reimplemented in pcbnew.SHAPE_LINE_CHAIN, and pcbnew.SHAPE_POLY_SET.

Definition at line 4260 of file pcbnew.py.

Centre()

"VECTOR2I" pcbnew.SHAPE.Centre

(

self

)

Centre(SHAPE self) -> VECTOR2I

Definition at line 4264 of file pcbnew.py.

Clone()

"SHAPE *" pcbnew.SHAPE.Clone

(

self

)

Clone(SHAPE self) -> SHAPE

Reimplemented in pcbnew.SHAPE_LINE_CHAIN, and pcbnew.SHAPE_POLY_SET.

Definition at line 4243 of file pcbnew.py.

Here is the caller graph for this function:

Collide()

"bool" pcbnew.SHAPE.Collide	(		self,
		*	args
	)

    Collide(SHAPE self, VECTOR2I aP, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool
    Collide(SHAPE self, SHAPE aShape, int aClearance, VECTOR2I aMTV) -> bool
    Collide(SHAPE self, SHAPE aShape, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool
    Collide(SHAPE self, SEG const & aSeg, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool

Reimplemented in pcbnew.SHAPE_LINE_CHAIN_BASE, pcbnew.SHAPE_LINE_CHAIN, and pcbnew.SHAPE_POLY_SET.

Definition at line 4251 of file pcbnew.py.

Here is the caller graph for this function:

Format()

"std.string const" pcbnew.SHAPE.Format

(

self

)

Format(SHAPE self) -> string

Reimplemented in pcbnew.SHAPE_LINE_CHAIN, and pcbnew.SHAPE_POLY_SET.

Definition at line 4284 of file pcbnew.py.

IsNull()

"bool" pcbnew.SHAPE.IsNull

(

self

)

IsNull(SHAPE self) -> bool

Definition at line 4247 of file pcbnew.py.

IsSolid()

"bool" pcbnew.SHAPE.IsSolid

(

self

)

IsSolid(SHAPE self) -> bool

Reimplemented in pcbnew.SHAPE_LINE_CHAIN, and pcbnew.SHAPE_POLY_SET.

Definition at line 4276 of file pcbnew.py.

Move()

"void" pcbnew.SHAPE.Move	(		self,
		"VECTOR2I"	aVector
	)

Move(SHAPE self, VECTOR2I aVector)

Reimplemented in pcbnew.SHAPE_LINE_CHAIN, and pcbnew.SHAPE_POLY_SET.

Definition at line 4272 of file pcbnew.py.

Parse()

"bool" pcbnew.SHAPE.Parse	(		self,
		"std::stringstream &"	aStream
	)

Parse(SHAPE self, std::stringstream & aStream) -> bool

Reimplemented in pcbnew.SHAPE_LINE_CHAIN, and pcbnew.SHAPE_POLY_SET.

Definition at line 4280 of file pcbnew.py.

Rotate()

"void" pcbnew.SHAPE.Rotate	(		self,
		*	args
	)

Rotate(SHAPE self, double aAngle, VECTOR2I aCenter={ 0, 0 })

Reimplemented in pcbnew.SHAPE_LINE_CHAIN, and pcbnew.SHAPE_POLY_SET.

Definition at line 4268 of file pcbnew.py.

Member Data Documentation

MIN_PRECISION_IU

pcbnew.SHAPE.MIN_PRECISION_IU = _pcbnew.SHAPE_MIN_PRECISION_IU

static

Definition at line 4239 of file pcbnew.py.

Property Documentation

thisown

pcbnew.SHAPE.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 4234 of file pcbnew.py.

---

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

• pcbnew.py