class Sketchup::Page

The Page class contains methods to extract information and modify the properties of an individual page.

Note that inside the SketchUp user interface pages are called “Scenes”.

@version SketchUp 6.0

Public Instance Methods

axes() click to toggle source

The axes method returns the drawing axes for the page.

@example

page = Sketchup.active_model.pages.add("Example Page")
xaxis = Geom::Vector3d.new(3, 5, 0)
yaxis = xaxis * Z_AXIS
page.axes.set([10,0,0], xaxis, yaxis, Z_AXIS)

@return Axes - the axes for the page.

@version SketchUp 2016

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 25
def axes
end
camera() click to toggle source

The camera method retrieves the camera for a particular page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
camera = page.camera

@return camera - a Camera object if successful, nil if the page

does not save camera information

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 40
def camera
end
delay_time() click to toggle source

The delay_time method retrieves the amount of time, in seconds, that a page will be displayed before transition to another page during a tour.

The default delay time can be modified in the Model Info > Animation panel of the SketchUp User Interface. If this method returns -1, the default delay time is used.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
time = page.delay_time

@return time - the number of seconds of delay

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 59
def delay_time
end
delay_time=(seconds) click to toggle source

The delay_time= method sets the amount of time, in seconds, that a page will be displayed before transitioning to another page during a tour. If you set the delay for a page to be -1, the default delay time will be used.

The default delay time can be modified in the Model Info > Animation panel of the SketchUp User Interface.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
time = page.delay_time = 10

@param seconds

The number of seconds to set as the delay time.

@return time - the number of seconds of delay

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 81
def delay_time=(seconds)
end
description() click to toggle source

The description method retrieves the description for a page as found in the Scenes manager dialog.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
description = page.description

@return description - a textual description for the page.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 96
def description
end
description=(description) click to toggle source

The description method sets the description for a page as found in the Scenes manager dialog.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
description = page.description = "This is my first page"

@param description

A string description for the page.

@return description - the new string description for the page

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 114
def description=(description)
end
get_drawingelement_visibility(element) click to toggle source

The {#get_drawingelement_visibility} method is used to get the visibility of a drawing element on a particular page.

@example

model = Sketchup.active_model
entities = model.active_entities
point1 = Geom::Point3d.new(10,0,0)
constpoint = entities.add_cpoint(point1)
pages = model.pages
page = pages.add("My Page")
result = page.get_drawingelement_visibility(constpoint)

@param [Sketchup::Drawingelement] element

@return [Boolean] - true if visible, false if not.

@version SketchUp 2020.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 134
def get_drawingelement_visibility(element)
end
hidden_entities() click to toggle source

The hidden_entities method retrieves all hidden entities within a page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
entities = page.hidden_entities

@return entities - an Entities object containing hidden

entities on the page.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 149
def hidden_entities
end
include_in_animation=(include) click to toggle source

The {#include_in_animation=} method controls whether the page should be included when exporting an animation from the model.

@example Turn off animation for all pages.

model = Sketchup.active_model
model.pages.each { |page|
  page.include_in_animation = false
}

@param [Boolean] include

@return [Sketchup::Page]

@version SketchUp 2018

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 166
def include_in_animation=(include)
end
include_in_animation?() click to toggle source

The {#include_in_animation?} method determines whether the page should be included when exporting an animation from the model.

@example Toggle inclusion in animation for all pages.

model = Sketchup.active_model
in_animation = model.pages.select { |page| page.include_in_animation? }

@return [Boolean]

@version SketchUp 2018

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 179
def include_in_animation?
end
label() click to toggle source

The label method retrieves the label for a page from the page tab.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
label = page.label

@return label - a string label for the page tab

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 193
def label
end
layer_folders() click to toggle source

The {#layer_folders} method retrieves the hidden layer folders associated with a page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
folders = page.layer_folders

@return [Array<Sketchup::LayerFolder>, nil] Returns nil if {#use_hidden?}

returns +false+

@version SketchUp 2021.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 209
def layer_folders
end
layers() click to toggle source

The {#layers} method retrieves layers that don't use their default visibility on this page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
layers = page.layers

@example Test layer visibility

def visible_in_scene?(layer, scene)
  scene.layers.include?(layer) == hidden_by_default?(layer)
end

def hidden_by_default?(layer)
  layer.page_behavior & LAYER_HIDDEN_BY_DEFAULT == LAYER_HIDDEN_BY_DEFAULT
end

@return [Array<Sketchup::Layer>, nil] Returns nil if {#use_hidden?} returns

+false+

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 234
def layers
end
name() click to toggle source

The name method retrieves the name for a page from the page tab.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
name = page.name

@return label - a string name for the page tab

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 248
def name
end
name=(name) click to toggle source

The name= method sets the name for a page's tab.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
name = page.name = "Page Name"

@param name

The name of the page to be set.

@return name - the name that you have set

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 265
def name=(name)
end
rendering_options() click to toggle source

The rendering_options method retrieves a RenderingOptions object for the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
renderingoptions = page.rendering_options

@return renderingoptions - a RenderingOptions object

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 280
def rendering_options
end
set_drawingelement_visibility(element, visibility) click to toggle source

The {#set_drawingelement_visibility} method is used to change the visibility of a drawing element on a particular page. Only drawing elements on the root of the model, as well as nested instances of components, groups, and images are controlled by Page visibility.

@example

model = Sketchup.active_model
entities = model.active_entities
point1 = Geom::Point3d.new(10, 0, 0)
constpoint = entities.add_cpoint(point1)
pages = model.pages
page = pages.add("My Page")
page.set_drawingelement_visibility(constpoint, false)

@param [Sketchup::Drawingelement] element

@param [Boolean] visibility

@return [Boolean]

@version SketchUp 2020.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 304
def set_drawingelement_visibility(element, visibility)
end
set_visibility(arg1, arg2) click to toggle source

The {#set_visibility} method sets the visibility for a layer or layer folder on a page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
layer = model.layers.add("My Layer")
page.set_visibility(layer, false)

@overload set_visibility(layer, visible_for_page)

@param [Sketchup::Layer] layer
@param [Boolean] visible_for_page

@overload set_visibility(layer_folder, visible_for_page)

@version SketchUp 20201.0
@param [Sketchup::LayerFolder] layer_folder
@param [Boolean] visible_for_page

@return [Sketchup::Page] the page whose visibility was set.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 331
def set_visibility(arg1, arg2)
end
shadow_info() click to toggle source

The shadow_info method retrieves the ShadowInfo object for the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
shadowinfo = page.shadow_info

@return shadowinfo - a ShadowInfo object if successful, nil if

the page does not save shadow information

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 346
def shadow_info
end
style() click to toggle source

The style method retrieves the style associated with the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
style = page.style

@return style - the Style object if successful

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 360
def style
end
transition_time() click to toggle source

Get the amount of time that it takes to transition to this page during a slideshow or animation export. If this value is -1, it means to use the default transition time.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
time = page.transition_time

@return transitiontime - the amount of time it takes to

transition to this page during a slideshow or animation
export.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 378
def transition_time
end
transition_time=(trans_time) click to toggle source

The transition_time= method is used to set the transition time.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
time = page.transition_time=20

@param trans_time

The transition time in seconds.

@return transitiontime - the new transition time

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 395
def transition_time=(trans_time)
end
update(flags) click to toggle source

The {#update} method performs an update on the page properties based on the current view that the user has. What properties of the Page get updated are controlled via an integer whose bits corresponds to different properties. These flags can be used individually or combined using bitwise OR.

PAGE_USE_CAMERA            # Camera Location
PAGE_USE_RENDERING_OPTIONS # Drawing Style
PAGE_USE_SHADOWINFO        # Shadow Setting
PAGE_USE_SKETCHCS          # Axes Location
PAGE_USE_HIDDEN            # Hidden Geometry & Objects (Up 2019 and older)
PAGE_USE_HIDDEN_GEOMETRY   # Hidden Geometry (SU 2020 and later)
PAGE_USE_HIDDEN_OBJECTS    # Hidden Objects (SU 2020 and later)
PAGE_USE_LAYER_VISIBILITY  # Visible Layers
PAGE_USE_SECTION_PLANES    # Active Section Planes
PAGE_USE_ALL               # All possible scene properties

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.update

# Updates Camera Location, Shadow Settings and Visible Layers.
flags = PAGE_USE_CAMERA | PAGE_USE_SHADOWINFO | PAGE_USE_LAYER_VISIBILITY
status = page.update(flags)

@param [Integer] flags

The bitwise OR of the bit flags.

@return [Boolean]

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 430
def update(flags)
end
use_axes=(pagesettings) click to toggle source

The use_axes= method sets the page's axes property.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
# Set use_axes to false
status = page.use_axes=false

@param pagesettings

true if you want your page to save this property, false
if you do not want your page to save this property.

@return status - true if you are saving the property, false if

you are not saving the property.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 450
def use_axes=(pagesettings)
end
use_axes?() click to toggle source

The use_axes? method determines whether you are storing the axes property with the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_axes?

@return [Boolean] status - true if you are storing the this property with

the page, false if you are not storing this property
with the page.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 467
def use_axes?
end
use_camera=(setting) click to toggle source

The use_camera= method sets the page's camera property.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_camera = true

@param setting

true if you want your page to save this property, false
if you do not want your page to save this property.

@return status - true if you are saving the property, false if

you are not saving the property.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 486
def use_camera=(setting)
end
use_camera?() click to toggle source

The use_camera? method determines whether you are storing the camera property with the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_camera?

@return [Boolean] status - true if you are storing the this property with

the page, false if you are not storing this property
with the page.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 503
def use_camera?
end
use_hidden=(setting) click to toggle source

The use_hidden= method sets the page's hidden property.

@deprecated The functionality is replaced by {use_hidden_geometry=}

and {use_hidden_objects=} in SketchUp 2020.1.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_hidden = false

@param setting

true if you want your page to save this property, false
if you do not want your page to save this property.

@return status - true if you are saving the property, false if

you are not saving the property.

@see use_hidden_geometry=

@see use_hidden_objects=

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 529
def use_hidden=(setting)
end
use_hidden?() click to toggle source

The use_hidden? method determines whether you are storing the hidden property with the page.

@deprecated The functionality is replaced by {use_hidden_geometry?}

and {use_hidden_objects?} in SketchUp 2020.1.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
status = page.use_hidden?

@return [Boolean] status - true if you are storing the this property with

the page, false if you are not storing this property
with the page.

@see use_hidden_geometry?

@see use_hidden_objects?

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 553
def use_hidden?
end
use_hidden_geometry=(setting) click to toggle source

Sets the page's use hidden geometry property.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
status = page.use_hidden_geometry = false

@param [Boolean] setting

`true` if you want your page to save this property,
`false` if you do not want your page to save this property.

@version SketchUp 2020.1

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 569
def use_hidden_geometry=(setting)
end
use_hidden_geometry?() click to toggle source

Returns the use hidden geometry property from the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
status = page.use_hidden_geometry?

@return [Boolean]

@version SketchUp 2020.1

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 583
def use_hidden_geometry?
end
use_hidden_layers=(setting) click to toggle source

The use_hidden_layers= method sets the page's hidden layers property.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_hidden_layers = false

@param setting

true if you want your page to save this property, false
if you do not want your page to save this property.

@return status - true if you are saving the property, false if

you are not saving the property.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 603
def use_hidden_layers=(setting)
end
use_hidden_layers?() click to toggle source

The use_hidden_layers? method determines whether you are storing the hidden layers property with the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_hidden_layers?

@return [Boolean] status - true if you are storing the this property with

the page, false if you are not storing this property
with the page.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 620
def use_hidden_layers?
end
use_hidden_objects=(setting) click to toggle source

Sets the page's use hidden objects property.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
status = page.use_hidden_objects = false

@param [Boolean] setting

`true` if you want your page to save this property,
`false` if you do not want your page to save this property.

@version SketchUp 2020.1

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 636
def use_hidden_objects=(setting)
end
use_hidden_objects?() click to toggle source

Returns the use hidden objects property from the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
status = page.use_hidden_objects?

@return [Boolean]

@version SketchUp 2020.1

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 650
def use_hidden_objects?
end
use_rendering_options=(setting) click to toggle source

The use_rendering_optoins= method sets the page's display settings property.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_rendering_options = false

@param setting

true if you want your page to save this property, false
if you do not want your page to save this property.

@return status - true if you are saving the property, false

if you are not saving the property.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 670
def use_rendering_options=(setting)
end
use_rendering_options?() click to toggle source

The use_rendering_options? method determines whether you are storing the rendering options property with the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_rendering_options?

@return [Boolean] status - true if you are storing the this property with

the page, false if you are not storing this property
with the page.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 687
def use_rendering_options?
end
use_section_planes=(setting) click to toggle source

The use_section_planes= method sets the page's section planes property.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_section_planes=false

@param setting

true if you want your page to save this property, false
if you do not want your page to save this property.

@return status - true if you are saving the property, false if

you are not saving the property.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 707
def use_section_planes=(setting)
end
use_section_planes?() click to toggle source

The use_section_planes? method determines whether you are storing the section planes property with the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_section_planes?

@return [Boolean] status - true if you are storing the this property with

the page, false if you are not storing this property
with the page.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 724
def use_section_planes?
end
use_shadow_info=(setting) click to toggle source

The use_shadow_info= method sets the page's shadow info property.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_shadow_info=false

@param setting

true if you want your page to save this property, false
if you do not want your page to save this property.

@return status - true if you are saving the property, false if

you are not saving the property.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 743
def use_shadow_info=(setting)
end
use_shadow_info?() click to toggle source

The use_shadow_info? method determines whether you are storing the shadow info property with the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_shadow_info?

@return [Boolean] status - true if you are storing the this property with

the page, false if you are not storing this property
with the page.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 760
def use_shadow_info?
end
use_style=(style) click to toggle source

The use_style= method sets the style to be used by the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
style = model.styles[0]
page.use_style = style

@param style

The Style object to use.

@return nil

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 778
def use_style=(style)
end
use_style?() click to toggle source

The use_style? method determines whether storing a style with the page.

@example

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
use_style = page.use_style?

@return [Boolean] status - true if you are storing the this property with

the page, false if you are not storing this property
with the page.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Page.rb, line 794
def use_style?
end