[frames] | no frames]

# Class Box

```object --+
|
nuke.Box
```

A 2-dimensional rectangle. Described by left, right, top and bottom coords (width and height are calculated as necessary).

 Instance Methods

 __init__(...) x.__init__(...) initializes x; see help(type(x)) for signature
a new object with type S, a subtype of T
 __new__(T, S, ...)
float
 centerX(self) Return center in X.
float
 centerY(self) Return height in Y.
int
 clampX(self, x) Return x restricted to pointing at a pixel in the box.
int
 clampY(self, y) Return y restricted to pointing at a pixel in the box.
None
 clear(self) Set to is_constant().
int
 h(self) Return height.
None
 intersect(self, x, y, r, t) Intersect with the given edges.
True if box is 1x1 in both directions, False otherwise.
 isConstant(self)
None
 merge(self, x, y, r, t) Merge with the given edges.
None
 move(self, dx, dy) Move all the sides and thus the entire box by the given deltas.
None
 pad(self, dx, dy, dr, dt) Move all the sides and thus the entire box by the given deltas.
int
 r(self) Return the right edge of the box.
None
 set(self, x, y, r, t) Set all values at once.
None
 setH(self, n) Set height by moving top edge.
None
 setR(self, n) Set the right edge.
None
 setT(self, n) Set top edge.
None
 setW(self, n) Set width by moving right edge.
None
 setX(self, n) Set the left edge.
None
 setY(self, n) Set the bottom edge.
int
int
 w(self) Return width.
int
 x(self) The left edge of the box.
int
 y(self) Return the bottom edge.

Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__sizeof__`, `__str__`, `__subclasshook__`

 Properties

Inherited from `object`: `__class__`

 Method Details

### __init__(...)(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

### __new__(T, S, ...)

Returns: a new object with type S, a subtype of T
Overrides: object.__new__

### setR(self, n)

Set the right edge. The parameter n is an integer.

Returns: None

### setX(self, n)

Set the left edge. The parameter n is an integer.

Returns: None

### setY(self, n)

Set the bottom edge. The parameter n is an integer.

Returns: None

 Generated by Epydoc 3.0.1 on Tue Dec 5 06:16:25 2017 http://epydoc.sourceforge.net