Class: Sketchup::InstancePath

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb

Overview

The InstancePath class represent the instance path to a given entity within the model hierarchy.

Version:

  • SketchUp 2017

Instance Method Summary collapse

Constructor Details

#initialize(path) ⇒ Sketchup::InstancePath

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])

Parameters:

  • path (Array<Sketchup::Entity>) —

    The leaf can be any entity, but the rest must be a group or component instance.

Raises:

  • (ArgumentError) —

    if the instance path isn’t composed of instances and an optional leaf entity.

Version:

  • SketchUp 2017



134
135
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 134

def initialize(path)
end

Instance Method Details

#==(other) ⇒ Boolean

Returns ‘true` if the instances paths represent the same set of entities.

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
if path.size > 1
  # do something
end

Returns:

  • (Boolean) —

    ‘true` if the instances paths represent the same set of entities.

Version:

  • SketchUp 2017



30
31
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 30

def ==(other)
end

#[](index) ⇒ Sketchup::Entity

The elements of an instance path can be accessed like an array.

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
path[0] == group # returns true
path[1] == edge # returns true

Parameters:

  • index (Integer)

Returns:

Raises:

  • (IndexError) —

    if the given index is out of bounds

  • (TypeError) —

    if the index is not of integer type

  • (TypeError) —

    if the instance path refer to deleted entities.

Version:

  • SketchUp 2017



54
55
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 54

def [](index)
end

#each {|Sketchup::Entity| ... } ⇒ nil

The yielded entities will start with the root and end with the leaf.

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
path.each { |entity|
  # do something
}

Yields:

Returns:

  • (nil)

Raises:

  • (TypeError) —

    if the instance path refer to deleted entities.

Version:

  • SketchUp 2017



75
76
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 75

def each
end

#empty? ⇒ Boolean

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
if path.empty?
  # do something...
end

Returns:

  • (Boolean)

Raises:

  • (TypeError) —

    if the instance path refer to deleted entities.

Version:

  • SketchUp 2017



93
94
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 93

def empty?
end

#include?(object) ⇒ Boolean

Returns ‘true` if the instance path contain the given object.

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
if path.include?(edge)
  # do something...
end

Parameters:

  • object (Object)

Returns:

  • (Boolean)

Raises:

  • (TypeError) —

    if the instance path refer to deleted entities.

Version:

  • SketchUp 2017



114
115
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 114

def include?(object)
end

#leaf ⇒ Sketchup::Entity

The leaf of an instance path is the last element which can be any entity that can be represented in the model. This is normally a Drawingelement, but could be a Vertex.

An instance can also be a leaf.

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
path.leaf == edge # returns true

Returns:

Raises:

  • (TypeError) —

    if the instance path refer to deleted entities.

Version:

  • SketchUp 2017



155
156
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 155

def leaf
end

#length ⇒ Integer

#length is an alias of #size.

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
if path.length > 1
  # do something
end

Returns:

  • (Integer)

Raises:

  • (TypeError) —

    if the instance path refer to deleted entities.

See Also:

Version:

  • SketchUp 2017



176
177
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 176

def length
end

#persistent_id_path ⇒ String

The serialized version of an instance path is the persistent ids of its entities concatenated with a period.

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
pid_path = path.persistent_id_path # something like "342.345"

Returns:

Raises:

  • (TypeError) —

    if the instance path refer to deleted entities.

See Also:

Version:

  • SketchUp 2017



196
197
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 196

def persistent_id_path
end

#root ⇒ Sketchup::Group, ...

The root of an instance path is the element located closest to the model root. This will be a group or component instance. If you have a non-instance as a leaf with no other parent component this will return ‘nil`.

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
path.root == group # returns true

Returns:

Raises:

  • (TypeError) —

    if the instance path refer to deleted entities.

Version:

  • SketchUp 2017



215
216
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 215

def root
end

#size ⇒ Integer

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
if path.size > 1
  # do something
end

Returns:

  • (Integer)

Raises:

  • (TypeError) —

    if the instance path refer to deleted entities.

See Also:

Version:

  • SketchUp 2017



235
236
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 235

def size
end

#to_a ⇒ Array

Returns an array representing the instance path.

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
pid_string = path.to_a.join('.')

Returns:

  • (Array) —

    an array representing the instance path.

Raises:

  • (TypeError) —

    if the instance path refer to deleted entities.

Version:

  • SketchUp 2017



251
252
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 251

def to_a
end

#transformation ⇒ Geom::Transformation #transformation(index) ⇒ Geom::Transformation

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
tr = path.transformation

Overloads:

  • #transformation ⇒ Geom::Transformation

    Returns the combined transformation up to the the leaf entity.

    Returns:

  • #transformation(index) ⇒ Geom::Transformation

    Returns the combined transformation up to the the given index.

    Parameters:

    • index (Integer)

    Returns:

Raises:

  • (IndexError) —

    if the given index is out of bounds

  • (TypeError) —

    if the index is not of integer type

  • (TypeError) —

    if the instance path refer to deleted entities.

Version:

  • SketchUp 2017



280
281
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 280

def transformation(*args)
end

#valid? ⇒ Boolean

An instance path is valid if it has at least one element and consist of groups and instances with exception of the leaf which can be any entity.

This method doesn’t check if the path can actually be looked up in the model.

Examples:

model = Sketchup.active_model
group = model.entities.add_group
edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
path = Sketchup::InstancePath.new([group, edge])
if path.valid?
  # do something...
end

Returns:

  • (Boolean)

Version:

  • SketchUp 2017



300
301
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb', line 300

def valid?
end