Class: Geom::BoundingBox

Inherits:
Object
  • Object
show all
Defined in:
lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb

Overview

Note:

that the bounding box returned for face-me components is the center of its entire range of motion. This behavior changed in SketchUp 7.1. In 7.0 and earlier, the .bounds method would return the bounds around the face-me component’s current, visible center.

Bounding boxes are three-dimensional boxes (eight corners), aligned with the axes, that surround entities within your model. There is a default bounding box for any new model that will surround all entities, including all groups and components. Additionally, there are bounding boxes for Drawingelement objects, including components and groups. Bounding boxes are only large enough to exactly bound the entities within your model, group, or component.

You can also create arbitrary BoundingBox objects by calling BoundingBox.new.

Examples:

# You can get the bounding box on a model.
model = Sketchup.active_model
model_bb = model.bounds

# Or you can get the bounding box on any Drawingelement object.
first_entity = model.entities[0]
first_entity_bb = first_entity.bounds

# Or you can create an empty bounding box of your own.
boundingbox = Geom::BoundingBox.new

Version:

  • SketchUp 6.0

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Geom::BoundingBox

The new method is used to create a new, empty, bounding box.

Examples:

boundingbox = Geom::BoundingBox.new

Version:

  • SketchUp 6.0



229
230
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 229

def initialize
end

Instance Method Details

#add(point_or_bb) ⇒ Geom::BoundingBox #add(points_or_bb) ⇒ Geom::BoundingBox

The add method is used to add a point, vertex, or other bounding boxes to the bounding box. The size of the bounding box will increase as necessary to accommodate the new items.

Adding one point to an empty bounding box does not increase the size of the bounding box. You must add at least two points before methods such as BoundingBox.diagonal will return a size greater than zero.

Examples:

model = Sketchup.active_model
boundingbox = model.bounds
point1 = Geom::Point3d.new(100, 200, 300)
point2 = Geom::Point3d.new(200, 400, 200)
boundingbox.add(point1, point2)

Overloads:

Returns:

Version:

  • SketchUp 6.0



63
64
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 63

def add(*args)
end

#center ⇒ Geom::Point3d

The center method is used to retrieve the Point3d object at the center of the bounding box.

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [200, 400, 100])
# This will return a point Point3d(150, 300, -150).
point = boundingbox.center

Returns:

  • (Geom::Point3d) —

    the Point3d at the center of the bounding box if successful

Version:

  • SketchUp 6.0



79
80
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 79

def center
end

#clear ⇒ Geom::BoundingBox

The clear method is used to clear a bounding box.

A cleared BoundingBox does not have a size greater than zero until you add at least two points or another bounding box.

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [200, 400, 100])

# This will return false.
boundingbox.empty?

boundingbox.clear
# This will return true.
boundingbox.empty?

Returns:

Version:

  • SketchUp 6.0



101
102
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 101

def clear
end

#contains?(point_or_bb) ⇒ Boolean

This method is used to determine if a bounding box contains a specific Point3d or BoundingBox object.

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [200, 400, 100])
# This will return false.
boundingbox.contains?([300, 100, 400])
# This will return true.
boundingbox.contains?([150, 300, -200])

Parameters:

Returns:

  • (Boolean)

Version:

  • SketchUp 6.0



120
121
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 120

def contains?(point_or_bb)
end

#corner(corner_index) ⇒ Geom::Point3d

The corner method is used to retrieve a point object at a specified corner of the bounding box.

There are 8 corners to a bounding box, identified by the numbers 0 through 7. Points are returned in the currently set units (inches, by default). These are which index refers to which corner:

- 0 = [0, 0, 0] (left front bottom)
- 1 = [1, 0, 0] (right front bottom)
- 2 = [0, 1, 0] (left back bottom)
- 3 = [1, 1, 0] (right back bottom)
- 4 = [0, 0, 1] (left front top)
- 5 = [1, 0, 1] (right front top)
- 6 = [0, 1, 1] (left back top)
- 7 = [1, 1, 1] (right back top)

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [200, 400, 100])
# This will return Point3d(100, 200, -400).
boundingbox.corner(0)
# This will return Point3d(100, 200, -400).
boundingbox.corner(6)

Parameters:

  • corner_index (Integer) —

    A number (from 0 to 7) representing point at the corner you want to retrieve.

Returns:

Version:

  • SketchUp 6.0



154
155
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 154

def corner(corner_index)
end

#depth ⇒ Length

Note:

In SketchUp’s coordinate system, this corresponds to the height.

The #depth method is used to retrieve the Z extents of the bounding box.

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [200, 400, 100])
# This will return a Length of 500.0.
height = boundingbox.depth

Returns:

Version:

  • SketchUp 6.0



170
171
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 170

def depth
end

#diagonal ⇒ Length

The #diagonal method is used to get the length of the diagonal of the bounding box.

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [200, 400, 100])
# This will return a point a Length of ~547.72.
length = boundingbox.diagonal

Returns:

  • (Length) —

    the size of the diagonal for the bounding box

Version:

  • SketchUp 6.0



186
187
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 186

def diagonal
end

#empty? ⇒ Boolean

The empty? method is used to determine if a bounding box is empty (such as if the bounds have not been set.) This returns the opposite of the valid? method.

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [200, 400, 100])
# This will return false.
boundingbox.empty?

Returns:

  • (Boolean)

Version:

  • SketchUp 6.0



202
203
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 202

def empty?
end

#height ⇒ Length

Note:

In SketchUp’s coordinate system, this corersponds to the depth.

The #height method is used to retrieve the Y extent of the bounding box.

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [200, 400, 100])
# This will return a Length of 200.0.
depth = boundingbox.height

Returns:

Version:

  • SketchUp 6.0



218
219
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 218

def height
end

#intersect(boundingbox) ⇒ Geom::BoundingBox

Note:

Prior to SU2015 this method would return incorrect result in some cases. For correct result in these versions you must first check if the boundingboxes actually overlap - then call this to get the resulting boundingbox.

The intersect method is used to retrieve a bounding box that is the result of intersecting one bounding box with another.

Examples:

boundingbox1 = Geom::BoundingBox.new
boundingbox1.add([100, 200, -400], [200, 400, 300])
boundingbox2 = Geom::BoundingBox.new
boundingbox2.add([150, 350, 100], [200, 400, 500])
# The returned boundingbox is a result of the intersection of the two.
boundingbox = boundingbox1.intersect(boundingbox2)

Parameters:

  • boundingbox (Geom::BoundingBox) —

    A second boundbox which might intersect boundingbox1.

Returns:

  • (Geom::BoundingBox) —

    the resulting BoundingBox object if successful, an empty BoundingBox object if unsuccessful.

Version:

  • SketchUp 6.0



255
256
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 255

def intersect(boundingbox)
end

#max ⇒ Geom::Point3d

The max method is used to retrieve the Point3d object where x, y and z are maximum in the bounding box.

If you attempt to call the max method on an empty bounding box, you will receive a very large negative number.

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [700, 900, 800], [200, 400, 100])
# This will return a point Point3d(700, 900, 800).
point = boundingbox.max

Returns:

  • (Geom::Point3d) —

    a Point3d object representing the point where x, y, and z are the maximum in the bounding box.

Version:

  • SketchUp 6.0



274
275
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 274

def max
end

#min ⇒ Geom::Point3d

The min method is used to retrieve the Point3d where x, y and z are minimum in the bounding box.

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [700, 900, 800], [200, 400, 100])
# This will return a point Point3d(100, 200, -400).
point = boundingbox.min

Returns:

  • (Geom::Point3d) —

    a Point3d object representing the point where x, y, and z are the maximum in the bounding box.

Version:

  • SketchUp 6.0



290
291
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 290

def min
end

#valid? ⇒ Boolean

The valid method is used to determine if a bounding box is valid (contains points).

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [200, 400, 100])
# This will return true.
boundingbox.valid?

Returns:

  • (Boolean)

Version:

  • SketchUp 6.0



305
306
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 305

def valid?
end

#width ⇒ Length

The #width method is used to retrieve the X extent of the bounding box.

Examples:

boundingbox = Geom::BoundingBox.new
boundingbox.add([100, 200, -400], [200, 400, 100])
# This will return a Length of 100.0.
width = boundingbox.width

Returns:

Version:

  • SketchUp 6.0



319
320
 
# File 'lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb', line 319

def width
end