nuke.Box¶
-
class
nuke.
Box
¶ Bases:
object
A 2-dimensional rectangle. Described by left, right, top and bottom coords (width and height are calculated as necessary).
Methods
Return center in X.
Return height in Y.
Return x restricted to pointing at a pixel in the box.
Return y restricted to pointing at a pixel in the box.
Set to is_constant().
Return height.
Intersect with the given edges.
Merge with the given edges.
Move all the sides and thus the entire box by the given deltas.
Move all the sides and thus the entire box by the given deltas.
Return the right edge of the box.
Set all values at once.
Set height by moving top edge.
Set the right edge.
Set top edge.
Set width by moving right edge.
Set the left edge.
Set the bottom edge.
Return top edge.
Return width.
The left edge of the box.
Return the bottom edge.
-
centerX
() → float¶ Return center in X.
-
centerY
() → float¶ Return height in Y.
-
clampX
(x) → int.¶ Return x restricted to pointing at a pixel in the box.
-
clampY
(y) → int.¶ Return y restricted to pointing at a pixel in the box.
-
clear
() → None.¶ Set to is_constant().
-
h
() → int¶ Return height.
-
intersect
(x, y, r, t) → None.¶ Intersect with the given edges.
-
isConstant
() → True if box is 1x1 in both directions, False otherwise.¶
-
merge
(x, y, r, t) → None.¶ Merge with the given edges.
-
move
(dx, dy) → None.¶ Move all the sides and thus the entire box by the given deltas.
-
pad
(dx, dy, dr, dt) → None.¶ Move all the sides and thus the entire box by the given deltas.
-
r
() → int¶ Return the right edge of the box.
-
set
(x, y, r, t) → None¶ Set all values at once.
-
setH
(n) → None¶ Set height by moving top edge.
-
setR
(n) → None¶ Set the right edge. The parameter n is an integer.
-
setT
(n) → None¶ Set top edge.
-
setW
(n) → None¶ Set width by moving right edge.
-
setX
(n) → None¶ Set the left edge. The parameter n is an integer.
-
setY
(n) → None¶ Set the bottom edge. The parameter n is an integer.
-
t
() → int¶ Return top edge.
-
w
() → int¶ Return width.
-
x
() → int¶ The left edge of the box.
-
y
() → int¶ Return the bottom edge.
-