cmsdk3.Box Class Reference

Inheritance diagram for cmsdk3.Box:

Collaboration diagram for cmsdk3.Box:

Public Member Functions
	__init__ (self, *args)
	getUpperY (self)
	getLowerY (self)
	getLeftX (self)
	getRightX (self)
	getArea (self)
	getCMX (self)
	getCMY (self)
	getCM (self)
	getUpperLeft (self)
	getUpperRight (self)
	getLowerLeft (self)
	getLowerRight (self)
	getLineWidth (self)
	getSize (self)
	getWidth (self)
	getHeight (self)
	__sub__ (self, *args)
	__add__ (self, *args)
	move (self, dx, dy)
	moveTo (self, x, y)
	set (self, x, y, w, h, linewidth=0)
	setUpperLeft (self, point)
	setSize (self, boxsize)
	setLineWidth (self, width)
	grow (self, dw, dh)
	isPointWithin (self, *args)
	getCentreMass (self)
	hasZeroSize (self)
	equals (self, *args)
	getBoundingBox (self, otherbox)
	growToBoundingBox (self, otherbox)
	growToIncludePoint (self, point, padX=0, padY=0)
	getOverlapBox (self, otherbox)
	percentOverlap (self, otherbox)
	getDoubleSizeSameCenter (self)
	constrainTo (self, *args)
	getConstrainedCopy (self, *args)
	__init__ (self, *args)
	getUpperY (self)
	getLowerY (self)
	getLeftX (self)
	getRightX (self)
	getArea (self)
	getCMX (self)
	getCMY (self)
	getCM (self)
	getUpperLeft (self)
	getUpperRight (self)
	getLowerLeft (self)
	getLowerRight (self)
	getLineWidth (self)
	getSize (self)
	getWidth (self)
	getHeight (self)
	__sub__ (self, *args)
	__add__ (self, *args)
	move (self, dx, dy)
	moveTo (self, x, y)
	set (self, x, y, w, h, linewidth=0)
	setUpperLeft (self, point)
	setSize (self, boxsize)
	setLineWidth (self, width)
	grow (self, dw, dh)
	isPointWithin (self, *args)
	getCentreMass (self)
	hasZeroSize (self)
	equals (self, *args)
	getBoundingBox (self, otherbox)
	growToBoundingBox (self, otherbox)
	growToIncludePoint (self, point, padX=0, padY=0)
	getOverlapBox (self, otherbox)
	percentOverlap (self, otherbox)
	getDoubleSizeSameCenter (self)
	constrainTo (self, *args)
	getConstrainedCopy (self, *args)
	__init__ (self, *args)
	getUpperY (self)
	getLowerY (self)
	getLeftX (self)
	getRightX (self)
	getArea (self)
	getCMX (self)
	getCMY (self)
	getCM (self)
	getUpperLeft (self)
	getUpperRight (self)
	getLowerLeft (self)
	getLowerRight (self)
	getLineWidth (self)
	getSize (self)
	getWidth (self)
	getHeight (self)
	__sub__ (self, *args)
	__add__ (self, *args)
	move (self, dx, dy)
	moveTo (self, x, y)
	set (self, x, y, w, h, linewidth=0)
	setUpperLeft (self, point)
	setSize (self, boxsize)
	setLineWidth (self, width)
	grow (self, dw, dh)
	isPointWithin (self, *args)
	getCentreMass (self)
	hasZeroSize (self)
	equals (self, *args)
	getBoundingBox (self, otherbox)
	growToBoundingBox (self, otherbox)
	growToIncludePoint (self, point, padX=0, padY=0)
	getOverlapBox (self, otherbox)
	percentOverlap (self, otherbox)
	getDoubleSizeSameCenter (self)
	constrainTo (self, *args)
	getConstrainedCopy (self, *args)

Protected Member Functions
	_print (self)
	_print (self)
	_print (self)

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
	upperLeft = property(_cmsdk3.Box_upperLeft_get, _cmsdk3.Box_upperLeft_set)
	size = property(_cmsdk3.Box_size_get, _cmsdk3.Box_size_set)
	lineWidth = property(_cmsdk3.Box_lineWidth_get, _cmsdk3.Box_lineWidth_set)
	name = property(_cmsdk3.Box_name_get, _cmsdk3.Box_name_set)
	comment = property(_cmsdk3.Box_comment_get, _cmsdk3.Box_comment_set)
	orientation = property(_cmsdk3.Box_orientation_get, _cmsdk3.Box_orientation_set)

Detailed Description

Definition at line 1534 of file cmsdk3.py.

Constructor & Destructor Documentation

__init__() [1/3]

cmsdk3.Box.__init__	(		self,
		*	args )

Definition at line 1538 of file cmsdk3.py.

__init__() [2/3]

cmsdk3.Box.__init__	(		self,
		*	args )

Definition at line 1594 of file cmsdk3.py.

__init__() [3/3]

cmsdk3.Box.__init__	(		self,
		*	args )

Definition at line 1538 of file cmsdk3.py.

Member Function Documentation

__add__() [1/3]

cmsdk3.Box.__add__	(		self,
		*	args )

Definition at line 1599 of file cmsdk3.py.

__add__() [2/3]

cmsdk3.Box.__add__	(		self,
		*	args )

Definition at line 1655 of file cmsdk3.py.

__add__() [3/3]

cmsdk3.Box.__add__	(		self,
		*	args )

Definition at line 1599 of file cmsdk3.py.

__sub__() [1/3]

cmsdk3.Box.__sub__	(		self,
		*	args )

Definition at line 1596 of file cmsdk3.py.

__sub__() [2/3]

cmsdk3.Box.__sub__	(		self,
		*	args )

Definition at line 1652 of file cmsdk3.py.

__sub__() [3/3]

cmsdk3.Box.__sub__	(		self,
		*	args )

Definition at line 1596 of file cmsdk3.py.

_print() [1/3]

cmsdk3.Box._print ( self )

protected

Definition at line 1659 of file cmsdk3.py.

_print() [2/3]

cmsdk3.Box._print ( self )

protected

Definition at line 1715 of file cmsdk3.py.

_print() [3/3]

cmsdk3.Box._print ( self )

protected

Definition at line 1659 of file cmsdk3.py.

constrainTo() [1/3]

cmsdk3.Box.constrainTo	(		self,
		*	args )

Definition at line 1653 of file cmsdk3.py.

constrainTo() [2/3]

cmsdk3.Box.constrainTo	(		self,
		*	args )

Definition at line 1709 of file cmsdk3.py.

constrainTo() [3/3]

cmsdk3.Box.constrainTo	(		self,
		*	args )

Definition at line 1653 of file cmsdk3.py.

equals() [1/3]

cmsdk3.Box.equals	(		self,
		*	args )

Definition at line 1632 of file cmsdk3.py.

equals() [2/3]

cmsdk3.Box.equals	(		self,
		*	args )

Definition at line 1688 of file cmsdk3.py.

equals() [3/3]

cmsdk3.Box.equals	(		self,
		*	args )

Definition at line 1632 of file cmsdk3.py.

getArea() [1/3]

cmsdk3.Box.getArea

(

self

)

Definition at line 1560 of file cmsdk3.py.

getArea() [2/3]

cmsdk3.Box.getArea

(

self

)

Definition at line 1616 of file cmsdk3.py.

getArea() [3/3]

cmsdk3.Box.getArea

(

self

)

Definition at line 1560 of file cmsdk3.py.

getBoundingBox() [1/3]

cmsdk3.Box.getBoundingBox	(		self,
			otherbox )

Definition at line 1635 of file cmsdk3.py.

getBoundingBox() [2/3]

cmsdk3.Box.getBoundingBox	(		self,
			otherbox )

Definition at line 1691 of file cmsdk3.py.

getBoundingBox() [3/3]

cmsdk3.Box.getBoundingBox	(		self,
			otherbox )

Definition at line 1635 of file cmsdk3.py.

getCentreMass() [1/3]

cmsdk3.Box.getCentreMass

(

self

)

Definition at line 1626 of file cmsdk3.py.

getCentreMass() [2/3]

cmsdk3.Box.getCentreMass

(

self

)

Definition at line 1682 of file cmsdk3.py.

getCentreMass() [3/3]

cmsdk3.Box.getCentreMass

(

self

)

Definition at line 1626 of file cmsdk3.py.

getCM() [1/3]

cmsdk3.Box.getCM

(

self

)

Definition at line 1569 of file cmsdk3.py.

getCM() [2/3]

cmsdk3.Box.getCM

(

self

)

Definition at line 1625 of file cmsdk3.py.

getCM() [3/3]

cmsdk3.Box.getCM

(

self

)

Definition at line 1569 of file cmsdk3.py.

getCMX() [1/3]

cmsdk3.Box.getCMX

(

self

)

Definition at line 1563 of file cmsdk3.py.

getCMX() [2/3]

cmsdk3.Box.getCMX

(

self

)

Definition at line 1619 of file cmsdk3.py.

getCMX() [3/3]

cmsdk3.Box.getCMX

(

self

)

Definition at line 1563 of file cmsdk3.py.

getCMY() [1/3]

cmsdk3.Box.getCMY

(

self

)

Definition at line 1566 of file cmsdk3.py.

getCMY() [2/3]

cmsdk3.Box.getCMY

(

self

)

Definition at line 1622 of file cmsdk3.py.

getCMY() [3/3]

cmsdk3.Box.getCMY

(

self

)

Definition at line 1566 of file cmsdk3.py.

getConstrainedCopy() [1/3]

cmsdk3.Box.getConstrainedCopy	(		self,
		*	args )

Definition at line 1656 of file cmsdk3.py.

getConstrainedCopy() [2/3]

cmsdk3.Box.getConstrainedCopy	(		self,
		*	args )

Definition at line 1712 of file cmsdk3.py.

getConstrainedCopy() [3/3]

cmsdk3.Box.getConstrainedCopy	(		self,
		*	args )

Definition at line 1656 of file cmsdk3.py.

getDoubleSizeSameCenter() [1/3]

cmsdk3.Box.getDoubleSizeSameCenter

(

self

)

Definition at line 1650 of file cmsdk3.py.

getDoubleSizeSameCenter() [2/3]

cmsdk3.Box.getDoubleSizeSameCenter

(

self

)

Definition at line 1706 of file cmsdk3.py.

getDoubleSizeSameCenter() [3/3]

cmsdk3.Box.getDoubleSizeSameCenter

(

self

)

Definition at line 1650 of file cmsdk3.py.

getHeight() [1/3]

cmsdk3.Box.getHeight

(

self

)

Definition at line 1593 of file cmsdk3.py.

getHeight() [2/3]

cmsdk3.Box.getHeight

(

self

)

Definition at line 1649 of file cmsdk3.py.

getHeight() [3/3]

cmsdk3.Box.getHeight

(

self

)

Definition at line 1593 of file cmsdk3.py.

getLeftX() [1/3]

cmsdk3.Box.getLeftX

(

self

)

Definition at line 1554 of file cmsdk3.py.

getLeftX() [2/3]

cmsdk3.Box.getLeftX

(

self

)

Definition at line 1610 of file cmsdk3.py.

getLeftX() [3/3]

cmsdk3.Box.getLeftX

(

self

)

Definition at line 1554 of file cmsdk3.py.

getLineWidth() [1/3]

cmsdk3.Box.getLineWidth

(

self

)

Definition at line 1584 of file cmsdk3.py.

getLineWidth() [2/3]

cmsdk3.Box.getLineWidth

(

self

)

Definition at line 1640 of file cmsdk3.py.

getLineWidth() [3/3]

cmsdk3.Box.getLineWidth

(

self

)

Definition at line 1584 of file cmsdk3.py.

getLowerLeft() [1/3]

cmsdk3.Box.getLowerLeft

(

self

)

Definition at line 1578 of file cmsdk3.py.

getLowerLeft() [2/3]

cmsdk3.Box.getLowerLeft

(

self

)

Definition at line 1634 of file cmsdk3.py.

getLowerLeft() [3/3]

cmsdk3.Box.getLowerLeft

(

self

)

Definition at line 1578 of file cmsdk3.py.

getLowerRight() [1/3]

cmsdk3.Box.getLowerRight

(

self

)

Definition at line 1581 of file cmsdk3.py.

getLowerRight() [2/3]

cmsdk3.Box.getLowerRight

(

self

)

Definition at line 1637 of file cmsdk3.py.

getLowerRight() [3/3]

cmsdk3.Box.getLowerRight

(

self

)

Definition at line 1581 of file cmsdk3.py.

getLowerY() [1/3]

cmsdk3.Box.getLowerY

(

self

)

Definition at line 1551 of file cmsdk3.py.

getLowerY() [2/3]

cmsdk3.Box.getLowerY

(

self

)

Definition at line 1607 of file cmsdk3.py.

getLowerY() [3/3]

cmsdk3.Box.getLowerY

(

self

)

Definition at line 1551 of file cmsdk3.py.

getOverlapBox() [1/3]

cmsdk3.Box.getOverlapBox	(		self,
			otherbox )

Definition at line 1644 of file cmsdk3.py.

getOverlapBox() [2/3]

cmsdk3.Box.getOverlapBox	(		self,
			otherbox )

Definition at line 1700 of file cmsdk3.py.

getOverlapBox() [3/3]

cmsdk3.Box.getOverlapBox	(		self,
			otherbox )

Definition at line 1644 of file cmsdk3.py.

getRightX() [1/3]

cmsdk3.Box.getRightX

(

self

)

Definition at line 1557 of file cmsdk3.py.

getRightX() [2/3]

cmsdk3.Box.getRightX

(

self

)

Definition at line 1613 of file cmsdk3.py.

getRightX() [3/3]

cmsdk3.Box.getRightX

(

self

)

Definition at line 1557 of file cmsdk3.py.

getSize() [1/3]

cmsdk3.Box.getSize

(

self

)

Definition at line 1587 of file cmsdk3.py.

getSize() [2/3]

cmsdk3.Box.getSize

(

self

)

Definition at line 1643 of file cmsdk3.py.

getSize() [3/3]

cmsdk3.Box.getSize

(

self

)

Definition at line 1587 of file cmsdk3.py.

getUpperLeft() [1/3]

cmsdk3.Box.getUpperLeft

(

self

)

Definition at line 1572 of file cmsdk3.py.

getUpperLeft() [2/3]

cmsdk3.Box.getUpperLeft

(

self

)

Definition at line 1628 of file cmsdk3.py.

getUpperLeft() [3/3]

cmsdk3.Box.getUpperLeft

(

self

)

Definition at line 1572 of file cmsdk3.py.

getUpperRight() [1/3]

cmsdk3.Box.getUpperRight

(

self

)

Definition at line 1575 of file cmsdk3.py.

getUpperRight() [2/3]

cmsdk3.Box.getUpperRight

(

self

)

Definition at line 1631 of file cmsdk3.py.

getUpperRight() [3/3]

cmsdk3.Box.getUpperRight

(

self

)

Definition at line 1575 of file cmsdk3.py.

getUpperY() [1/3]

cmsdk3.Box.getUpperY

(

self

)

Definition at line 1548 of file cmsdk3.py.

getUpperY() [2/3]

cmsdk3.Box.getUpperY

(

self

)

Definition at line 1604 of file cmsdk3.py.

getUpperY() [3/3]

cmsdk3.Box.getUpperY

(

self

)

Definition at line 1548 of file cmsdk3.py.

getWidth() [1/3]

cmsdk3.Box.getWidth

(

self

)

Definition at line 1590 of file cmsdk3.py.

getWidth() [2/3]

cmsdk3.Box.getWidth

(

self

)

Definition at line 1646 of file cmsdk3.py.

getWidth() [3/3]

cmsdk3.Box.getWidth

(

self

)

Definition at line 1590 of file cmsdk3.py.

grow() [1/3]

cmsdk3.Box.grow	(		self,
			dw,
			dh )

Definition at line 1620 of file cmsdk3.py.

grow() [2/3]

cmsdk3.Box.grow	(		self,
			dw,
			dh )

Definition at line 1676 of file cmsdk3.py.

grow() [3/3]

cmsdk3.Box.grow	(		self,
			dw,
			dh )

Definition at line 1620 of file cmsdk3.py.

growToBoundingBox() [1/3]

cmsdk3.Box.growToBoundingBox	(		self,
			otherbox )

Definition at line 1638 of file cmsdk3.py.

growToBoundingBox() [2/3]

cmsdk3.Box.growToBoundingBox	(		self,
			otherbox )

Definition at line 1694 of file cmsdk3.py.

growToBoundingBox() [3/3]

cmsdk3.Box.growToBoundingBox	(		self,
			otherbox )

Definition at line 1638 of file cmsdk3.py.

growToIncludePoint() [1/3]

cmsdk3.Box.growToIncludePoint	(		self,
			point,
			padX = 0,
			padY = 0 )

Definition at line 1641 of file cmsdk3.py.

growToIncludePoint() [2/3]

cmsdk3.Box.growToIncludePoint	(		self,
			point,
			padX = 0,
			padY = 0 )

Definition at line 1697 of file cmsdk3.py.

growToIncludePoint() [3/3]

cmsdk3.Box.growToIncludePoint	(		self,
			point,
			padX = 0,
			padY = 0 )

Definition at line 1641 of file cmsdk3.py.

hasZeroSize() [1/3]

cmsdk3.Box.hasZeroSize

(

self

)

Definition at line 1629 of file cmsdk3.py.

hasZeroSize() [2/3]

cmsdk3.Box.hasZeroSize

(

self

)

Definition at line 1685 of file cmsdk3.py.

hasZeroSize() [3/3]

cmsdk3.Box.hasZeroSize

(

self

)

Definition at line 1629 of file cmsdk3.py.

isPointWithin() [1/3]

cmsdk3.Box.isPointWithin	(		self,
		*	args )

Definition at line 1623 of file cmsdk3.py.

isPointWithin() [2/3]

cmsdk3.Box.isPointWithin	(		self,
		*	args )

Definition at line 1679 of file cmsdk3.py.

isPointWithin() [3/3]

cmsdk3.Box.isPointWithin	(		self,
		*	args )

Definition at line 1623 of file cmsdk3.py.

move() [1/3]

cmsdk3.Box.move	(		self,
			dx,
			dy )

Definition at line 1602 of file cmsdk3.py.

move() [2/3]

cmsdk3.Box.move	(		self,
			dx,
			dy )

Definition at line 1658 of file cmsdk3.py.

move() [3/3]

cmsdk3.Box.move	(		self,
			dx,
			dy )

Definition at line 1602 of file cmsdk3.py.

moveTo() [1/3]

cmsdk3.Box.moveTo	(		self,
			x,
			y )

Definition at line 1605 of file cmsdk3.py.

moveTo() [2/3]

cmsdk3.Box.moveTo	(		self,
			x,
			y )

Definition at line 1661 of file cmsdk3.py.

moveTo() [3/3]

cmsdk3.Box.moveTo	(		self,
			x,
			y )

Definition at line 1605 of file cmsdk3.py.

percentOverlap() [1/3]

cmsdk3.Box.percentOverlap	(		self,
			otherbox )

Definition at line 1647 of file cmsdk3.py.

percentOverlap() [2/3]

cmsdk3.Box.percentOverlap	(		self,
			otherbox )

Definition at line 1703 of file cmsdk3.py.

percentOverlap() [3/3]

cmsdk3.Box.percentOverlap	(		self,
			otherbox )

Definition at line 1647 of file cmsdk3.py.

set() [1/3]

cmsdk3.Box.set	(		self,
			x,
			y,
			w,
			h,
			linewidth = 0 )

Definition at line 1608 of file cmsdk3.py.

set() [2/3]

cmsdk3.Box.set	(		self,
			x,
			y,
			w,
			h,
			linewidth = 0 )

Definition at line 1664 of file cmsdk3.py.

set() [3/3]

cmsdk3.Box.set	(		self,
			x,
			y,
			w,
			h,
			linewidth = 0 )

Definition at line 1608 of file cmsdk3.py.

setLineWidth() [1/3]

cmsdk3.Box.setLineWidth	(		self,
			width )

Definition at line 1617 of file cmsdk3.py.

setLineWidth() [2/3]

cmsdk3.Box.setLineWidth	(		self,
			width )

Definition at line 1673 of file cmsdk3.py.

setLineWidth() [3/3]

cmsdk3.Box.setLineWidth	(		self,
			width )

Definition at line 1617 of file cmsdk3.py.

setSize() [1/3]

cmsdk3.Box.setSize	(		self,
			boxsize )

Definition at line 1614 of file cmsdk3.py.

setSize() [2/3]

cmsdk3.Box.setSize	(		self,
			boxsize )

Definition at line 1670 of file cmsdk3.py.

setSize() [3/3]

cmsdk3.Box.setSize	(		self,
			boxsize )

Definition at line 1614 of file cmsdk3.py.

setUpperLeft() [1/3]

cmsdk3.Box.setUpperLeft	(		self,
			point )

Definition at line 1611 of file cmsdk3.py.

setUpperLeft() [2/3]

cmsdk3.Box.setUpperLeft	(		self,
			point )

Definition at line 1667 of file cmsdk3.py.

setUpperLeft() [3/3]

cmsdk3.Box.setUpperLeft	(		self,
			point )

Definition at line 1611 of file cmsdk3.py.

Property Documentation

comment

cmsdk3.Box.comment = property(_cmsdk3.Box_comment_get, _cmsdk3.Box_comment_set)

static

Definition at line 1545 of file cmsdk3.py.

lineWidth

cmsdk3.Box.lineWidth = property(_cmsdk3.Box_lineWidth_get, _cmsdk3.Box_lineWidth_set)

static

Definition at line 1543 of file cmsdk3.py.

name

cmsdk3.Box.name = property(_cmsdk3.Box_name_get, _cmsdk3.Box_name_set)

static

Definition at line 1544 of file cmsdk3.py.

orientation

cmsdk3.Box.orientation = property(_cmsdk3.Box_orientation_get, _cmsdk3.Box_orientation_set)

static

Definition at line 1546 of file cmsdk3.py.

size

cmsdk3.Box.size = property(_cmsdk3.Box_size_get, _cmsdk3.Box_size_set)

static

Definition at line 1542 of file cmsdk3.py.

thisown

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

static

Definition at line 1535 of file cmsdk3.py.

upperLeft

cmsdk3.Box.upperLeft = property(_cmsdk3.Box_upperLeft_get, _cmsdk3.Box_upperLeft_set)

static

Definition at line 1541 of file cmsdk3.py.

---

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

• /home/ubuntu/c/partner/psyclone2/CMSDK/bin/linux64/cmsdk3.py
• /home/ubuntu/c/partner/psyclone2/CMSDK/build/cmsdk3.py
• /home/ubuntu/c/partner/psyclone2/CMSDK/src/cmsdk3.py