Class: Wx::Rect2DDouble

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/geometry.rb,
lib/wx/doc/geometry.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

Rect2DDouble is an axis-aligned rectangle; each side of the rect is parallel to the X or Y axis.

The rectangle is either defined by the top left and bottom right corner, or by the top left corner and size. A point is contained within the rectangle if left <= m_x < right and top <= m_y < bottom; thus, it is a half open interval.

Note:

Rect2DDouble has subtle differences from Rect in how its edge and corner functions work. With Rect2DDouble, there are two counterparts: - SetXXX functions, which keep the other corners at their position whenever sensible - MoveXXX functions, which keep the size of the rectangle and move the other corners appropriately

Requires:

  • USE_GEOMETRY

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::Rect2DDouble #initialize(x, y, width, height) ⇒ Wx::Rect2DDouble #initialize(rect) ⇒ Wx::Rect2DDouble

Returns a new instance of Rect2DDouble.

Overloads:



299
 
# File 'lib/wx/doc/gen/geometry.rb', line 299

def initialize(*args) end

Class Method Details

.intersect(src1, src2) ⇒ Wx::Rect2DDouble

Returns the intersecting rectangle of two rectangles.

Parameters:

Returns:



612
 
# File 'lib/wx/doc/gen/geometry.rb', line 612

def self.intersect(src1, src2) end

.union(src1, src2) ⇒ Wx::Rect2DDouble

Returns the union rectangle of two rectangles.

Parameters:

Returns:



638
 
# File 'lib/wx/doc/gen/geometry.rb', line 638

def self.union(src1, src2) end

Instance Method Details

#==(rect) ⇒ Boolean

Equality operator.

Parameters:

Returns:

  • (Boolean) 


281
 
# File 'lib/wx/doc/gen/geometry.rb', line 281

def ==(rect) end

#assign(pt) ⇒ self

Parameters:

Returns:

  • (self) 


173
 
# File 'lib/wx/doc/geometry.rb', line 173

def assign(pt) end

#constrain_to(rect) ⇒ void

This method returns an undefined value.

Resizes the rectangle to fit within the dimensions of another rectangle.

Parameters:



596
 
# File 'lib/wx/doc/gen/geometry.rb', line 596

def constrain_to(rect) end

#contains(pt) ⇒ Boolean #contains(rect) ⇒ Boolean

Overloads:

  • #contains(pt) ⇒ Boolean

    Returns true if the given point is inside the rectangle (or on its boundary) and false otherwise.

    Parameters:

    Returns:

    • (Boolean)
  • #contains(rect) ⇒ Boolean

    Returns true if the given rectangle is completely inside this rectangle (or touches its boundary) and false otherwise.

    Parameters:

    Returns:

    • (Boolean) 


549
 
# File 'lib/wx/doc/gen/geometry.rb', line 549

def contains(*args) end

#create_intersection(otherRect) ⇒ Wx::Rect2DDouble

Returns the intersecting rectangle of this rectangle with another one.

Parameters:

Returns:



617
 
# File 'lib/wx/doc/gen/geometry.rb', line 617

def create_intersection(otherRect) end

#create_union(otherRect) ⇒ Wx::Rect2DDouble

Returns the union of this rectangle with another one.

Parameters:

Returns:



643
 
# File 'lib/wx/doc/gen/geometry.rb', line 643

def create_union(otherRect) end

#deflate(dx, dy) ⇒ Wx::Rect2DDouble #deflate(d) ⇒ Wx::Rect2DDouble #deflate(d) ⇒ Wx::Rect2DDouble

Overloads:

  • #deflate(dx, dy) ⇒ Wx::Rect2DDouble

    Decrease the rectangle size.

    This method is the opposite from #inflate: Deflate(a, b) is equivalent to Inflate(-a, -b). Please refer to #inflate for full description.

    Parameters:

    • dx (Float)
    • dy (Float)

    Returns:

  • #deflate(d) ⇒ Wx::Rect2DDouble

    This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

    Parameters:

    Returns:

  • #deflate(d) ⇒ Wx::Rect2DDouble

    This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

    Parameters:

    • d (Float)

    Returns:



276
 
# File 'lib/wx/doc/gen/geometry.rb', line 276

def deflate(*args) end

#get_bottom ⇒ Float Also known as: bottom

Returns the bottom point of the rectangle.

Returns:

  • (Float) 


389
 
# File 'lib/wx/doc/gen/geometry.rb', line 389

def get_bottom; end

#get_centre ⇒ Wx::Point2DDouble Also known as: centre

Returns the centre point of the rectangle.

Returns:



521
 
# File 'lib/wx/doc/gen/geometry.rb', line 521

def get_centre; end

#get_height ⇒ Float Also known as: height

Returns the height.

Returns:

  • (Float) 


164
 
# File 'lib/wx/doc/geometry.rb', line 164

def get_height; end

#get_left ⇒ Float Also known as: left

Returns the left point of the rectangle (the same as #get_x).

Returns:

  • (Float) 


345
 
# File 'lib/wx/doc/gen/geometry.rb', line 345

def get_left; end

#get_left_bottom ⇒ Wx::Point2DDouble Also known as: left_bottom

Returns the position of the bottom left corner.

Returns:



455
 
# File 'lib/wx/doc/gen/geometry.rb', line 455

def get_left_bottom; end

#get_left_top ⇒ Wx::Point2DDouble Also known as: left_top

Returns the position of the top left corner of the rectangle, same as #get_position.

Returns:



433
 
# File 'lib/wx/doc/gen/geometry.rb', line 433

def get_left_top; end

#get_out_code(pt) ⇒ Wx::OutCode Also known as: out_code

Returns the relative location of a point to the rectangle (e.g., inside or to the left of it).

Parameters:

Returns:



538
 
# File 'lib/wx/doc/gen/geometry.rb', line 538

def get_out_code(pt) end

#get_position ⇒ Wx::Point2DDouble Also known as: position

Returns the position.

Returns:



303
 
# File 'lib/wx/doc/gen/geometry.rb', line 303

def get_position; end

#get_right ⇒ Float Also known as: right

Returns the right point of the rectangle.

Returns:

  • (Float) 


411
 
# File 'lib/wx/doc/gen/geometry.rb', line 411

def get_right; end

#get_right_bottom ⇒ Wx::Point2DDouble Also known as: right_bottom

Returns the position of the bottom right corner.

Returns:



499
 
# File 'lib/wx/doc/gen/geometry.rb', line 499

def get_right_bottom; end

#get_right_top ⇒ Wx::Point2DDouble Also known as: right_top

Returns the position of the top right corner.

Returns:



477
 
# File 'lib/wx/doc/gen/geometry.rb', line 477

def get_right_top; end

#get_size ⇒ Wx::Size Also known as: size

Returns the size.

Returns:



308
 
# File 'lib/wx/doc/gen/geometry.rb', line 308

def get_size; end

#get_top ⇒ Float Also known as: top

Returns the top point of the rectangle (the same as #get_y).

Returns:

  • (Float) 


367
 
# File 'lib/wx/doc/gen/geometry.rb', line 367

def get_top; end

#get_width ⇒ Float Also known as: width

Returns the width.

Returns:

  • (Float) 


156
 
# File 'lib/wx/doc/geometry.rb', line 156

def get_width; end

#get_x ⇒ Float Also known as: x

Returns the left position of the rectangle.

Returns:

  • (Float) 


140
 
# File 'lib/wx/doc/geometry.rb', line 140

def get_x; end

#get_y ⇒ Float Also known as: y

Returns the top position of the rect.

Returns:

  • (Float) 


148
 
# File 'lib/wx/doc/geometry.rb', line 148

def get_y; end

#have_equal_size(rect) ⇒ Boolean

Returns true if another rectangle has the same width and height.

Parameters:

Returns:

  • (Boolean) 


559
 
# File 'lib/wx/doc/gen/geometry.rb', line 559

def have_equal_size(rect) end

#inflate(dx, dy) ⇒ Wx::Rect2DDouble #inflate(d) ⇒ Wx::Rect2DDouble #inflate(d) ⇒ Wx::Rect2DDouble

Overloads:

  • #inflate(dx, dy) ⇒ Wx::Rect2DDouble

    Increases the size of the rectangle.

    The left border is moved farther left and the right border is moved farther right by dx. The upper border is moved farther up and the bottom border is moved farther down by dy. (Note that the width and height of the rectangle thus change by 2dx and 2dy, respectively.) If one or both of dx and dy are negative, the opposite happens: the rectangle size decreases in the respective direction. Inflating and deflating behaves “naturally”. Defined more precisely, that means:

    • “Real” inflates (that is, dx and/or dy = 0) are not constrained. Thus inflating a rectangle can cause its upper left corner to move into the negative numbers. (2.5.4 and older forced the top left coordinate to not fall below (0, 0), which implied a forced move of the rectangle.)

    • Deflates are clamped to not reduce the width or height of the rectangle below zero. In such cases, the top-left corner is nonetheless handled properly. For example, a rectangle at (10, 10) with size (20, 40) that is inflated by (-15, -15) will become located at (20, 25) at size (0, 10). Finally, observe that the width and height are treated independently. In the above example, the width is reduced by 20, whereas the height is reduced by the full 30 (rather than also stopping at 20, when the width reached zero).

    Parameters:

    • dx (Float)
    • dy (Float)

    Returns:

    See Also:

  • #inflate(d) ⇒ Wx::Rect2DDouble

    This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

    Parameters:

    Returns:

  • #inflate(d) ⇒ Wx::Rect2DDouble

    This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

    Parameters:

    • d (Float)

    Returns:



259
 
# File 'lib/wx/doc/gen/geometry.rb', line 259

def inflate(*args) end

#inset(x, y) ⇒ void #inset(left, top, right, bottom) ⇒ void

Overloads:

  • #inset(x, y) ⇒ void

    This method returns an undefined value.

    Offsets the rectangle by x and y, but maintains the bottom right corner.

    Note:

    This will affect the width and height of the rectangle.

    Parameters:

    • x (Float)
    • y (Float)
  • #inset(left, top, right, bottom) ⇒ void

    This method returns an undefined value.

    Parameters:

    • left (Float)
    • top (Float)
    • right (Float)
    • bottom (Float) 


578
 
# File 'lib/wx/doc/gen/geometry.rb', line 578

def inset(*args) end

#interpolate(widthfactor, heightfactor) ⇒ Wx::Point2DDouble

Parameters:

  • widthfactor (Integer)
  • heightfactor (Integer)

Returns:



601
 
# File 'lib/wx/doc/gen/geometry.rb', line 601

def interpolate(widthfactor, heightfactor) end

#intersect(otherRect) ⇒ void

This method returns an undefined value.

Constrains the rectangle to the intersection of another rectangle.

Parameters:



606
 
# File 'lib/wx/doc/gen/geometry.rb', line 606

def intersect(otherRect) end

#intersects(rect) ⇒ Boolean

Returns true if this rectangle has a non-empty intersection with the rectangle rect and false otherwise.

Parameters:

Returns:

  • (Boolean) 


622
 
# File 'lib/wx/doc/gen/geometry.rb', line 622

def intersects(rect) end

#is_empty ⇒ Boolean Also known as: empty?

Returns true if this rectangle has a width or height less than or equal to 0 and false otherwise.

Returns:

  • (Boolean) 


553
 
# File 'lib/wx/doc/gen/geometry.rb', line 553

def is_empty; end

#move_bottom_to(n) ⇒ void

This method returns an undefined value.

Set the bottom edge of the rectangle, preserving the height.

Parameters:

  • n (Float) 


407
 
# File 'lib/wx/doc/gen/geometry.rb', line 407

def move_bottom_to(n) end

#move_centre_to(pt) ⇒ void

This method returns an undefined value.

An alias for #move_centre_to.

Parameters:



533
 
# File 'lib/wx/doc/gen/geometry.rb', line 533

def move_centre_to(pt) end

#move_left_bottom_to(pt) ⇒ void

This method returns an undefined value.

Set the bottom-left point of the rectangle, while preserving the width and height of the rectangle.

Parameters:



473
 
# File 'lib/wx/doc/gen/geometry.rb', line 473

def move_left_bottom_to(pt) end

#move_left_to(n) ⇒ void

This method returns an undefined value.

Sets the left position, which may adjust the width of the rectangle.

Parameters:

  • n (Float) 


363
 
# File 'lib/wx/doc/gen/geometry.rb', line 363

def move_left_to(n) end

#move_left_top_to(pt) ⇒ void

This method returns an undefined value.

Set the top-left point of the rectangle, while preserving the width and height of the rectangle.

Parameters:



451
 
# File 'lib/wx/doc/gen/geometry.rb', line 451

def move_left_top_to(pt) end

#move_right_bottom_to(pt) ⇒ void

This method returns an undefined value.

Set the bottom-right point of the rectangle, while preserving the width and height of the rectangle.

Parameters:



517
 
# File 'lib/wx/doc/gen/geometry.rb', line 517

def move_right_bottom_to(pt) end

#move_right_to(n) ⇒ void

This method returns an undefined value.

Set the right side of the rectangle, preserving the width.

Parameters:

  • n (Float) 


429
 
# File 'lib/wx/doc/gen/geometry.rb', line 429

def move_right_to(n) end

#move_right_top_to(pt) ⇒ void

This method returns an undefined value.

Set the top-right point of the rectangle, while preserving the width and height of the rectangle.

Parameters:



495
 
# File 'lib/wx/doc/gen/geometry.rb', line 495

def move_right_top_to(pt) end

#move_top_to(n) ⇒ void

This method returns an undefined value.

Set the top edge of the rectangle, preserving the height.

Parameters:

  • n (Float) 


385
 
# File 'lib/wx/doc/gen/geometry.rb', line 385

def move_top_to(n) end

#offset(pt) ⇒ void #offset(dx, dy) ⇒ void

Overloads:

  • #offset(pt) ⇒ void

    This method returns an undefined value.

    Moves the rectangle by the specified offset.

    If X of pt is positive, the rectangle is moved to the right, if Y of pt is positive, it is moved to the bottom, otherwise it is moved to the left or top respectively.

    Parameters:

  • #offset(dx, dy) ⇒ void

    This method returns an undefined value.

    This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

    Parameters:

    • dx (Float)
    • dy (Float) 


591
 
# File 'lib/wx/doc/gen/geometry.rb', line 591

def offset(*args) end

#scale(f) ⇒ void #scale(num, denum) ⇒ void

Overloads:

  • #scale(f) ⇒ void

    This method returns an undefined value.

    Parameters:

    • f (Float)
  • #scale(num, denum) ⇒ void

    This method returns an undefined value.

    Parameters:

    • num (Integer)
    • denum (Integer) 


652
 
# File 'lib/wx/doc/gen/geometry.rb', line 652

def scale(*args) end

#set_bottom(n) ⇒ void Also known as: bottom=

This method returns an undefined value.

Set the bottom edge of the rectangle.

Note:

This will preserve the top position and alter the height of the rectangle. Use #move_bottom_to to only move the bottom.

Parameters:

  • n (Float) 


401
 
# File 'lib/wx/doc/gen/geometry.rb', line 401

def set_bottom(n) end

#set_centre(pt) ⇒ void Also known as: centre=

This method returns an undefined value.

Recenters (i.e., moves) the rectangle to the given point.

Parameters:



527
 
# File 'lib/wx/doc/gen/geometry.rb', line 527

def set_centre(pt) end

#set_height(h) ⇒ void Also known as: height=

This method returns an undefined value.

Sets the height.

Parameters:

  • h (Float) 


168
 
# File 'lib/wx/doc/geometry.rb', line 168

def set_height(v) end

#set_left(n) ⇒ void Also known as: left=

This method returns an undefined value.

Set the left side of the rectangle.

Note:

This will preserve the width of the rectangle. Use #move_left_to to change the left position of the rectangle, adjusting its width accordingly.

Parameters:

  • n (Float) 


357
 
# File 'lib/wx/doc/gen/geometry.rb', line 357

def set_left(n) end

#set_left_bottom(pt) ⇒ void Also known as: left_bottom=

This method returns an undefined value.

Set the bottom-left point of the rectangle.

Note:

This will alter the width and height of the rectangle. Use #move_left_bottom_to to only move the left bottom corner.

Parameters:



467
 
# File 'lib/wx/doc/gen/geometry.rb', line 467

def set_left_bottom(pt) end

#set_left_top(pt) ⇒ void Also known as: left_top=

This method returns an undefined value.

Set the top-left point of the rectangle.

Note:

This will alter the height of the rectangle. Use #move_left_top_to to only move the top.

Parameters:



445
 
# File 'lib/wx/doc/gen/geometry.rb', line 445

def set_left_top(pt) end

#set_right(n) ⇒ void Also known as: right=

This method returns an undefined value.

Set the right side of the rectangle.

Note:

This will preserve the left position and alter the width of the rectangle. Use #move_right_to to only move the bottom.

Parameters:

  • n (Float) 


423
 
# File 'lib/wx/doc/gen/geometry.rb', line 423

def set_right(n) end

#set_right_bottom(pt) ⇒ void Also known as: right_bottom=

This method returns an undefined value.

Set the bottom-right point of the rectangle.

Note:

This will alter the width and height of the rectangle. Use #move_right_bottom_to to only move the right bottom corner.

Parameters:



511
 
# File 'lib/wx/doc/gen/geometry.rb', line 511

def set_right_bottom(pt) end

#set_right_top(pt) ⇒ void Also known as: right_top=

This method returns an undefined value.

Set the top-right point of the rectangle.

Note:

This will alter the width and height of the rectangle. Use #move_right_top_to to only move the right top corner.

Parameters:



489
 
# File 'lib/wx/doc/gen/geometry.rb', line 489

def set_right_top(pt) end

#set_top(n) ⇒ void Also known as: top=

This method returns an undefined value.

Set the top edge of the rectangle.

Note:

This will alter the height of the rectangle. Use #move_top_to to only move the top.

Parameters:

  • n (Float) 


379
 
# File 'lib/wx/doc/gen/geometry.rb', line 379

def set_top(n) end

#set_width(w) ⇒ void Also known as: width=

This method returns an undefined value.

Sets the width.

Parameters:

  • w (Float) 


160
 
# File 'lib/wx/doc/geometry.rb', line 160

def set_width(v) end

#set_x(v) ⇒ Float Also known as: x=

Parameters:

  • v (Float)

Returns:

  • (Float) 


144
 
# File 'lib/wx/doc/geometry.rb', line 144

def set_x(v) end

#set_y(v) ⇒ Float

Parameters:

  • v (Float)

Returns:

  • (Float) 


152
 
# File 'lib/wx/doc/geometry.rb', line 152

def set_y(v) end

#to_rect ⇒ Wx::Rect

Returns the rectangle as a Wx::Rect.

Returns:



656
 
# File 'lib/wx/doc/gen/geometry.rb', line 656

def to_rect; end

#union(otherRect) ⇒ void #union(pt) ⇒ void

Overloads:

  • #union(otherRect) ⇒ void

    This method returns an undefined value.

    Expands the rectangle to the union with another rectangle.

    Parameters:

  • #union(pt) ⇒ void

    This method returns an undefined value.

    Expands the rectangle to include the point at pt.

    Parameters:



632
 
# File 'lib/wx/doc/gen/geometry.rb', line 632

def union(*args) end

#y= ⇒ Float

Parameters:

  • v (Float)

Returns:

  • (Float) 


153
 
# File 'lib/wx/doc/geometry.rb', line 153

def set_height(v) end