Class: Layout::Entity

Inherits:

Object

Object
Layout::Entity

show all

Defined in:: SketchUp/Layout/Entity.rb

Overview

An entity is an object shown on a page of a LayOut document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
# Get the shared entities in the document. If there are no shared layers,
# the resulting array will be empty.
entities = doc.entities
# Count how many of the entites are a rectangle
rectangle_count = 0

# Look at all of the entities in the array.
entities.each { |entity|
  if entity.is_a?(Layout::Rectangle)
    rectangle_count = rectangle_count++
  end
}

Version:

LayOut 2018

Direct Known Subclasses

AngularDimension, Ellipse, FormattedText, Group, Image, Label, LinearDimension, Path, Rectangle, SketchUpModel, Table

Instance Method Summary collapse

#==(other) ⇒ Boolean

The #== method checks to see if the two Entitys are equal.
#bounds ⇒ Geom::Bounds2d

The #bounds method returns the 2D rectangular bounds of the Entity.
#document ⇒ Layout::Document^?

The #document method returns the Document that the Entity belongs to, or nil if it is not in a Document.
#drawing_bounds ⇒ Geom::OrientedBounds2d

The #drawing_bounds method returns the 2D rectangular drawing bounds of the Entity.
#group ⇒ Layout::Group^?

The #group method returns the Group the Entity belongs to, or nil if it is not in a Group.
#layer_instance ⇒ Layout::LayerInstance^?

The #layer_instance method returns the LayerInstance that the Entity is on, or nil if it is not associated with a LayerInstance.
#locked=(is_locked) ⇒ Object

The #locked= method sets the Entity as locked or unlocked.
#locked? ⇒ Boolean

The #locked? method returns whether the Entity is locked or unlocked.
#move_to_group(group) ⇒ Object

The #move_to_group method moves the Entity into a Group.
#move_to_layer(*args) ⇒ Object

The #move_to_layer method moves the Entity to the given Layer.
#on_shared_layer? ⇒ Boolean

The #on_shared_layer? method returns whether or not the Entity is on a shared Layer.
#page ⇒ Layout::Page^?

The #page method returns the Page that the Entity belongs to, or nil if it is on a shared Layer or not in a Document.
#style ⇒ Layout::Style^?

The #style method returns the Style of the Entity.
#style=(style) ⇒ Object

The #style= method sets the Style of the Entity.
#transform!(transformation) ⇒ Object

The #transform! method transforms the Entity with a given Geom::Transformation2d.
#transformation ⇒ Geom::Transformation2d^?

The #transformation method returns the explicit Geom::Transformation2d.
#untransformed_bounds ⇒ Geom::Bounds2d

The #untransformed_bounds method returns the untransformed bounds of the Entity.
#untransformed_bounds=(bounds) ⇒ Object

The #untransformed_bounds= method sets the untransformed bounds of the Entity.

Instance Method Details

#==(other) ⇒ `Boolean`

The #== method checks to see if the two Layout::Entitys are equal. This checks whether the Ruby Objects are pointing to the same internal object.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page_entities = doc.pages.first.entities
layer_entities = doc.layers.first.layer_instance(page).entities
page_entities.first == layer_entities.first

Parameters:

other (Layout::Entity)

Returns:

(Boolean)

Version:

LayOut 2018



40
41

# File 'SketchUp/Layout/Entity.rb', line 40

def ==(other)
end

#bounds ⇒ `Geom::Bounds2d`

The #bounds method returns the 2D rectangular bounds of the Layout::Entity.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
bounds = entities.first.bounds

Returns:

(Geom::Bounds2d)

Version:

LayOut 2018



53
54

# File 'SketchUp/Layout/Entity.rb', line 53

def bounds
end

#document ⇒ `Layout::Document`^?

The #document method returns the Document that the Layout::Entity belongs to, or nil if it is not in a Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.shared_entities
# entity_doc should be the same document as doc
entity_doc = entities.first.document

Returns:

(Layout::Document, nil)

Version:

LayOut 2018



68
69

# File 'SketchUp/Layout/Entity.rb', line 68

def document
end

#drawing_bounds ⇒ `Geom::OrientedBounds2d`

The #drawing_bounds method returns the 2D rectangular drawing bounds of the Layout::Entity.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
draw_bounds = entities.first.drawing_bounds

Returns:

(Geom::OrientedBounds2d)

Version:

LayOut 2018



82
83

# File 'SketchUp/Layout/Entity.rb', line 82

def drawing_bounds
end

#group ⇒ `Layout::Group`^?

The #group method returns the Group the Layout::Entity belongs to, or nil if it is not in a Group.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages
entities = pages.first.entities
group = entities.first.group

Returns:

(Layout::Group, nil)

Version:

LayOut 2018



97
98

# File 'SketchUp/Layout/Entity.rb', line 97

def group
end

#layer_instance ⇒ `Layout::LayerInstance`^?

Note:

Groups are never associated with a LayerInstance.

The #layer_instance method returns the LayerInstance that the Layout::Entity is on, or nil if it is not associated with a LayerInstance.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
entity_layer_instance = entities.first.layer_instance

Returns:

(Layout::LayerInstance, nil)

Version:

LayOut 2018



114
115

# File 'SketchUp/Layout/Entity.rb', line 114

def layer_instance
end

#locked=(is_locked) ⇒ `Object`

The #locked= method sets the Layout::Entity as locked or unlocked. When locked, the Layout::Entity cannot be modified directly.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
entities.first.locked = true

Parameters:

is_locked (Boolean)

Version:

LayOut 2018



128
129

# File 'SketchUp/Layout/Entity.rb', line 128

def locked=(is_locked)
end

#locked? ⇒ `Boolean`

The #locked? method returns whether the Layout::Entity is locked or unlocked.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
is_first_locked = entities.first.locked?

Returns:

(Boolean)
(Boolean)

Version:

LayOut 2018



144
145

# File 'SketchUp/Layout/Entity.rb', line 144

def locked?
end

#move_to_group(group) ⇒ `Object`

The #move_to_group method moves the Layout::Entity into a Group. If the Layout::Entity is already in a Group, it will be removed from that Group prior to being added to the new one. If this action results in the old Group containing only one Layout::Entity, the old Group will be collapsed and the remaining Layout::Entity will be moved to the old Group‘s parent.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
new_group = Layout::Group.new
entities.first.move_to_group(new_group)

Parameters:

group (Layout::Group)

Raises:

(LockedLayerError) —

if the Layout::Entity is on a locked Layer
(ArgumentError) —

if entity and group are not in the same Document
(ArgumentError) —

if entity and group are not on the same Page
(ArgumentError) —

if of entity and group one is shared and one is not
(LockedEntityError) —

if the Layout::Entity is locked

Version:

LayOut 2018



175
176

# File 'SketchUp/Layout/Entity.rb', line 175

def move_to_group(group)
end

#move_to_layer(layer) ⇒ `Object` #move_to_layer(layer, pages) ⇒ `Object`

The #move_to_layer method moves the Layout::Entity to the given Layer. If the Layer is non-shared and the Layout::Entity is currently on a shared Layer, an array of Pages must be provided to move the Layout::Entity to. In all other cases, passing in an array of Pages is not necessary. The Layout::Entity must belong to the same Document as the the Layer and the Pages.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
layers = doc.layers
entities.last.move_to_layer(layers.first)

Overloads:

#move_to_layer(layer) ⇒ Object
Parameters:
- layer (Layout::Layer)
#move_to_layer(layer, pages) ⇒ Object
Parameters:
- layer (Layout::Layer)
- pages (Array<Layout::Page>)

Raises:

(ArgumentError) —

if layer is shared and a valid array of non-duplicate Pages is not passed in
(ArgumentError) —

if entity, layer, and pages are not all in the same Document
(LockedLayerError) —

if the Layout::Entity is on a locked Layer
(LockedLayerError) —

if layer is locked
(LockedEntityError) —

if the Layout::Entity is locked

Version:

LayOut 2018



215
216

# File 'SketchUp/Layout/Entity.rb', line 215

def move_to_layer(*args)
end

#on_shared_layer? ⇒ `Boolean`

The #on_shared_layer? method returns whether or not the Layout::Entity is on a shared Layer. This function works for all Layout::Entity types, including Group. Groups do not belong to a specific Layer, but their children are all on either a shared or non-shared Layer.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
on_shared_layer = entities.first.on_shared_layer?

Returns:

(Boolean)
(Boolean)

Raises:

(ArgumentError) —

if the Layout::Entity is not in a Document

Version:

LayOut 2018



236
237

# File 'SketchUp/Layout/Entity.rb', line 236

def on_shared_layer?
end

#page ⇒ `Layout::Page`^?

The #page method returns the Page that the Layout::Entity belongs to, or nil if it is on a shared Layer or not in a Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
# page will be nil
page = doc.shared_entities.first.page
# page will be the first page of the document
page = doc.pages.first.nonshared_entities.first.page

Returns:

(Layout::Page, nil)

Version:

LayOut 2018



253
254

# File 'SketchUp/Layout/Entity.rb', line 253

def page
end

#style ⇒ `Layout::Style`^?

The #style method returns the Style of the Layout::Entity. If the Layout::Entity is a Group, nil will be returned, as they do not have a Style.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.entities
style = entities.first.style

Returns:

(Layout::Style, nil)

Version:

LayOut 2018



268
269

# File 'SketchUp/Layout/Entity.rb', line 268

def style
end

#style=(style) ⇒ `Object`

The #style= method sets the Style of the Layout::Entity.

Parameters:

style (Layout::Style)

Raises:

(LockedLayerError) —

if the Layout::Entity is on a locked Layer
(LockedEntityError) —

if the Layout::Entity is locked

Version:

LayOut 2018



281
282

# File 'SketchUp/Layout/Entity.rb', line 281

def style=(style)
end

#transform!(transformation) ⇒ `Object`

The #transform! method transforms the Layout::Entity with a given Geom::Transformation2d.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
transform = Geom::Transformation2d.new([1.0, 0.0, 0.0, 1.0, 1.0, 1.0])
entity = entities.first.transform!(transform)

Parameters:

transformation (Geom::Transformation2d)

Raises:

(LockedLayerError) —

if the Layout::Entity is on a locked Layer
(LockedEntityError) —

if the Layout::Entity is locked

Version:

LayOut 2018



301
302

# File 'SketchUp/Layout/Entity.rb', line 301

def transform!(transformation)
end

#transformation ⇒ `Geom::Transformation2d`^?

The #transformation method returns the explicit Geom::Transformation2d.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
transform = entities.first.transformation

Returns:

(Geom::Transformation2d, nil)

Version:

LayOut 2018



314
315

# File 'SketchUp/Layout/Entity.rb', line 314

def transformation
end

#untransformed_bounds ⇒ `Geom::Bounds2d`

The #untransformed_bounds method returns the untransformed bounds of the Layout::Entity. This is the bounds of the Layout::Entity before its explicit Geom::Transformation2d is applied.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
bounds = entities.first.untransformed_bounds

Returns:

(Geom::Bounds2d)

Raises:

(ArgumentError) —

if the Layout::Entity does not have an explicit Geom::Transformation2d

Version:

LayOut 2018



332
333

# File 'SketchUp/Layout/Entity.rb', line 332

def untransformed_bounds
end

#untransformed_bounds=(bounds) ⇒ `Object`

The #untransformed_bounds= method sets the untransformed bounds of the Layout::Entity. This is the bounds of the Layout::Entity before its explicit Geom::Transformation2d is applied.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.pages.first.entities
point1 = Geom::Point2d.new(1, 1)
point2 = Geom::Point2d.new(2, 2)
bounds = Geom::Bounds2d(point1, point2)
entities.first.untransformed_bounds = bounds

Parameters:

bounds (Geom::Bounds2d)

Raises:

(ArgumentError) —

if the Layout::Entity does not have an explicit Geom::Transformation2d
(LockedLayerError) —

if the Layout::Entity is on a locked Layer
(LockedEntityError) —

if the Layout::Entity is locked
(ArgumentError) —

if the bounds are of zero size

Version:

LayOut 2018



360
361

# File 'SketchUp/Layout/Entity.rb', line 360

def untransformed_bounds=(bounds)
end

Class: Layout::Entity

Overview

Examples:

Direct Known Subclasses

Instance Method Summary collapse

Instance Method Details

#==(other) ⇒ Boolean

Examples:

#bounds ⇒ Geom::Bounds2d

Examples:

#document ⇒ Layout::Document?

Examples:

#drawing_bounds ⇒ Geom::OrientedBounds2d

Examples:

#group ⇒ Layout::Group?

Examples:

#layer_instance ⇒ Layout::LayerInstance?

Examples:

#locked=(is_locked) ⇒ Object

Examples:

#locked? ⇒ Boolean

Examples:

#move_to_group(group) ⇒ Object

Examples:

#move_to_layer(layer) ⇒ Object #move_to_layer(layer, pages) ⇒ Object

Examples:

#on_shared_layer? ⇒ Boolean

Examples:

#page ⇒ Layout::Page?

Examples:

#style ⇒ Layout::Style?

Examples:

#style=(style) ⇒ Object

#transform!(transformation) ⇒ Object

Examples:

#transformation ⇒ Geom::Transformation2d?

Examples:

#untransformed_bounds ⇒ Geom::Bounds2d

Examples:

#untransformed_bounds=(bounds) ⇒ Object

Examples:

#==(other) ⇒ `Boolean`

#bounds ⇒ `Geom::Bounds2d`

#document ⇒ `Layout::Document`^?

#drawing_bounds ⇒ `Geom::OrientedBounds2d`

#group ⇒ `Layout::Group`^?

#layer_instance ⇒ `Layout::LayerInstance`^?

#locked=(is_locked) ⇒ `Object`

#locked? ⇒ `Boolean`

#move_to_group(group) ⇒ `Object`

#move_to_layer(layer) ⇒ `Object` #move_to_layer(layer, pages) ⇒ `Object`

#on_shared_layer? ⇒ `Boolean`

#page ⇒ `Layout::Page`^?

#style ⇒ `Layout::Style`^?

#style=(style) ⇒ `Object`

#transform!(transformation) ⇒ `Object`

#transformation ⇒ `Geom::Transformation2d`^?

#untransformed_bounds ⇒ `Geom::Bounds2d`

#untransformed_bounds=(bounds) ⇒ `Object`