class Layout::Image
A raster image entity.
@example
image = Layout::Image.new("my_image.png", [[1, 1], [3, 3]]) clip_mask = image.clip_mask if clip_mask.is_a?(Layout::Rectangle) point1 = Geom::Point2d.new(1, 1) point2 = Geom::Point2d.new(2, 2) bounds = [point1, point2] image.clip_mask = Layout::Ellipse.new(bounds) end
@version LayOut 2018
Public Class Methods
The {#initialize} method creates a new {Layout::Image} from a given image file.
@example
image = Layout::Image.new("my_image.png", [[1, 1], [3, 3]])
@param [String] path
The path to the file
@param [Geom::Bounds2d] bounds
@raise [ArgumentError] if bounds are zero size
@raise [ArgumentError] if there was an error reading the image file, such as
the file name being invalid
@raise [RuntimeError] if there was an error allocating memory for the image
@return [Layout::Image]
@version LayOut 2018
# File lib/sketchup-api-stubs/stubs/Layout/Image.rb, line 88 def initialize(path, bounds) end
Public Instance Methods
The {#clip_mask} method returns the clip mask of the {Layout::Image}, or nil
if it does not have a clip mask.
@example
image = Layout::Image.new("my_image.png", [[1, 1], [3, 3]]) clip_mask = image.clip_mask
@return [Layout::Entity] The clip mask can be a {Layout::Path},
{Layout::Rectangle}, or {Layout::Ellipse}.
@version LayOut 2018
# File lib/sketchup-api-stubs/stubs/Layout/Image.rb, line 32 def clip_mask end
The {#clip_mask=} method sets the clip mask of the {Layout::Image}. clip_mask
can be a {Layout::Rectangle}, {Layout::Ellipse}, or {Layout::Path}, or nil
, and it must not currently exist in a {Layout::Document}, or {Layout::Group}.
@example
image = Layout::Image.new("my_image.png", [[1, 1], [3, 3]]) point1 = Geom::Point2d.new(1, 1) point2 = Geom::Point2d.new(2, 2) bounds = [point1, point2] clip_mask = Layout::Rectangle.new(bounds) image.clip_mask = clip_mask
@note clip_mask
may be nil
as of LayOut 2020.1.
@param [Layout::Entity, nil] clip_mask
The clip mask can be a {Layout::Path}, {Layout::Rectangle}, {Layout::Ellipse}, or +nil+.
@raise [ArgumentError] if clip mask is already in a {Layout::Document} or
{Layout::Group}
@raise [ArgumentError] if clip mask is not a {Layout::Path},
{Layout::Rectangle}, or {Layout::Ellipse}
@raise [LockedLayerError] if the {Layout::Image} is on a locked {Layout::Layer}
@raise [LockedEntityError] if the {Layout::Image} is locked
@version LayOut 2018
# File lib/sketchup-api-stubs/stubs/Layout/Image.rb, line 64 def clip_mask=(clip_mask) end