Class: Sketchup::Pages

Inherits:

Entity

Object
Entity
Sketchup::Pages

show all

Includes:: Enumerable

Defined in:: lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb

Overview

The Pages class contains methods for manipulating a collection of Pages (Named “scenes” in the UI.) in a model.

You get a handle to this collection by calling Model.pages.

Examples:

model = Sketchup.active_model
pages = model.pages

Version:

SketchUp 6.0

Constant Summary collapse

ImageEmbedded = Constants

nil

ImageEmbeddedAndLinked = Stub value.

nil

ImageLinked = Stub value.

nil

UnitsNormalizedX = Stub value.

nil

UnitsNormalizedY = Stub value.

nil

UnitsPixels = Stub value.

nil

Class Method Summary collapse

.add_frame_change_observer(object) ⇒ Integer

The Pages.add_frame_change_observer method is used to add a new frame change observer that is called with each frame of an animation, meaning the end user has clicked on a Scene tab (aka Page) inside SketchUp and the camera is animating to that scene.
.remove_frame_change_observer(observer_id) ⇒ Boolean

The Pages.remove_frame_change_observer method is used to remove a frame change observer.

Instance Method Summary collapse

#[](index_or_name) ⇒ Object

The [] method retrieves a page by either name or index.
#add(name = nil, flags = PAGE_USE_ALL, index = self.size) ⇒ Sketchup::Page

The #add method is used to add a new Page object to the collection.
#add_matchphoto_page(image_name, camera, page_name) ⇒ Object

The add_matchphoto_page method is used to add a photomatch page to the model.
#add_observer(observer) ⇒ Object

The add_observer method is used to add an observer to the Pages object.
#count ⇒ Integer
#each {|page| ... } ⇒ Object

The each method is used to iterate through pages.
#erase(page) ⇒ Boolean

The #erase method is used to remove a page from the collection.
#length ⇒ Integer

The #length method is an alias for #size.
#parent ⇒ Object

The parent method is used to determine the model for the Pages collection.
#remove_observer(observer) ⇒ Object

The remove_observer method is used to remove an observer from the current object.
#selected_page ⇒ Object

The selected_page method is used to retrieve the currently selected page.
#selected_page=(page) ⇒ Object

The selected_page method is used to set the currently selected page.
#show_frame_at(seconds) ⇒ Array(Sketchup::Page, Float)^?

The #show_frame_at method is used to show a frame in animation (of the slide show) at a given time in seconds.
#size ⇒ Integer

The #size method is used to retrieve the number of pages.
#slideshow_time ⇒ Object

The slideshow_time method is used to get the amount of time that a slideshow of all of the pages will take.

Methods inherited from Entity

#attribute_dictionaries, #attribute_dictionary, #delete_attribute, #deleted?, #entityID, #get_attribute, #inspect, #model, #persistent_id, #set_attribute, #to_s, #typename, #valid?

Class Method Details

.add_frame_change_observer(object) ⇒ `Integer`

The add_frame_change_observer method is used to add a new frame change observer that is called with each frame of an animation, meaning the end user has clicked on a Scene tab (aka Page) inside SketchUp and the camera is animating to that scene.

The method returns an integer id that can be stored and later used to remove the observer with the remove_frame_change_observer method.

Examples:

class MyFrameChangeObserver
  def frameChange(from_page, to_page, percent_done)
    puts "From page #{from_page.name} to #{to_page.name} (#{percent_done * 100}%)"
  end
end
id = Sketchup::Pages.add_frame_change_observer(MyFrameChangeObserver.new)

Parameters:

object (#frameChange) —

An object that implements the FrameChangeObserver#frameChange method.

Returns:

(Integer) —

A unique id of the observer

See Also:

FrameChangeObserver#frameChange

Version:

SketchUp 6.0



57
58

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 57

def self.add_frame_change_observer(object)
end

.remove_frame_change_observer(observer_id) ⇒ `Boolean`

The remove_frame_change_observer method is used to remove a frame change observer

Examples:

Sketchup::Pages.remove_frame_change_observer(id)

Parameters:

observer_id (Integer) —

The unique id returned by add_frame_change_observer

Returns:

(Boolean)

Version:

SketchUp 6.0



72
73

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 72

def self.remove_frame_change_observer(observer_id)
end

Instance Method Details

#[](index_or_name) ⇒ `Object`

The [] method retrieves a page by either name or index.

Examples:

model = Sketchup.active_model
pages = model.pages
status = pages.add "Page 1"
status = pages.add "Page 2"
page = pages["Page 2"]
if (page)
  UI.messagebox page
else
  UI.messagebox "Failure"
end

Parameters:

index_or_name —

The index or the string name of the specific page.

Returns:

page - a Page object if successful

Version:

SketchUp 6.0



97
98

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 97

def [](index_or_name)
end

#add(name = nil, flags = PAGE_USE_ALL, index = self.size) ⇒ `Sketchup::Page`

The #add method is used to add a new Page object to the collection.

If no name is given, then a new name is generated using the default name for new Pages. If a name is given, then a new Page with that name is added.

If the flags parameter is given, it controls which properties are saved with the Page. See the Sketchup::Page#update method for a description of the flags that can be set.

If index is given, it specifies the position in the page list that the new page is added. Otherwise the new page is added to the end.

Examples:

model = Sketchup.active_model
pages = model.pages
status = pages.add "Page 1"
status = pages.add "Page 2"
if (status)
  UI.messagebox status
else
  UI.messagebox "Failure"
end

Parameters:

name (String) (defaults to: nil) —

The name of the specific page.
flags (Integer) (defaults to: PAGE_USE_ALL) —

Bit flags in integer form.
index (Integer) (defaults to: self.size) —

Index of where to inset.

Returns:

(Sketchup::Page)

Version:

SketchUp 6.0



136
137

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 136

def add(name = nil, flags = PAGE_USE_ALL, index = self.size)
end

#add_matchphoto_page(image_name, camera, page_name) ⇒ `Object`

The add_matchphoto_page method is used to add a photomatch page to the model. This is an advanced feature that was added to support internal SketchUp work, so it is unlikely to be useful to you.

Examples:

pages = Sketchup.active_model.pages
page = pages.add_matchphoto_page "Test"

Parameters:

image_name —

String image name.
camera (optional) —

Camera object.
page_name (optional) —

String page name.

Returns:

page - the new photomatch page.

Version:

SketchUp 7.0



159
160

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 159

def add_matchphoto_page(image_name, camera, page_name)
end

#add_observer(observer) ⇒ `Object`

The add_observer method is used to add an observer to the Pages object. See the PagesObserver interface for more details.

Examples:

pages = Sketchup.active_model.pages
status = pages.add_observer observer

Parameters:

observer —

An observer.

Returns:

true if successful, false if unsuccessful.

Version:

SketchUp 6.0



175
176

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 175

def add_observer(observer)
end

#count ⇒ `Integer`

Note:

Since SketchUp 2014 the count method is inherited from Ruby’s Enumable mix-in module. Prior to that the #count method is an alias for #length.

Examples:

pages = Sketchup.active_model.pages
pages.add('Page 1')
pages.add('Page 2')
number = pages.count

Returns:

(Integer)

See Also:

#length

Version:

SketchUp 6.0



194
195

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 194

def count
end

#each {|page| ... } ⇒ `Object`

The each method is used to iterate through pages.

Examples:

model = Sketchup.active_model
pages = model.pages
status = pages.add "Page 1"
status = pages.add "Page 2"
pages.each {|page| puts page}

Yields:

(page) —

Variables that will hold each page as it is found.

Returns:

Version:

SketchUp 6.0



211
212

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 211

def each
end

#erase(page) ⇒ `Boolean`

The #erase method is used to remove a page from the collection.

Examples:

page = Sketchup.active_model.pages.add('Hello World')
Sketchup.active_model.pages.erase(page)

Parameters:

page (Sketchup::Page)

Returns:

(Boolean)

Version:

SketchUp 6.0



225
226

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 225

def erase(page)
end

#length ⇒ `Integer`

The #length method is an alias for #size.

Examples:

pages = Sketchup.active_model.pages
pages.add('Page 1')
pages.add('Page 2')
number = pages.length

Returns:

(Integer)

See Also:

#size

Version:

SketchUp 2014



241
242

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 241

def length
end

#parent ⇒ `Object`

The parent method is used to determine the model for the Pages collection.

Examples:

model = Sketchup.active_model
pages = model.pages
status = pages.add "Page 1"
status = pages.add "Page 2"
model = pages.parent

Returns:

model - the model that contains the pages if successful

Version:

SketchUp 6.0



256
257

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 256

def parent
end

#remove_observer(observer) ⇒ `Object`

The remove_observer method is used to remove an observer from the current object. See the PagesObserver interface for more details.

Examples:

pages = Sketchup.active_model.pages
status = pages.remove_observer observer

Parameters:

observer —

An observer.

Returns:

true if successful, false if unsuccessful.

Version:

SketchUp 6.0



272
273

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 272

def remove_observer(observer)
end

#selected_page ⇒ `Object`

The selected_page method is used to retrieve the currently selected page.

Examples:

model = Sketchup.active_model
pages = model.pages
status = pages.add "Page 1"
status = pages.add "Page 2"
page = pages.selected_page

Returns:

page - the currently selected Page object if successful

Version:

SketchUp 6.0



287
288

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 287

def selected_page
end

#selected_page=(page) ⇒ `Object`

The selected_page method is used to set the currently selected page. Once you set this, SketchUp will animate to that page as if the user had clicked on its scene tab.

Examples:

model = Sketchup.active_model
pages = model.pages
status = pages.add "Page 1"
status = pages.add "Page 2"
pages.selected_page = model.pages[1]

Parameters:

page (Sketchup::Page)

Returns:

status - true if successful

Version:

SketchUp 6.0



306
307

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 306

def selected_page=(page)
end

#show_frame_at(seconds) ⇒ `Array(Sketchup::Page, Float)`^?

Note:

In versions prior to SketchUp 2019 this method will crash if called when there are no pages in the model.

The #show_frame_at method is used to show a frame in animation (of the slide show) at a given time in seconds.

Examples:

model = Sketchup.active_model
pages = model.pages
pages.add("Page 1")
pages.add("Page 2")
page, ratio = pages.show_frame_at(1.8)

Parameters:

seconds (Float) —

The time in seconds.

Returns:

(Array(Sketchup::Page, Float), nil) —

Upon success it returns the page that is displayed and a parameter between 0.0 and 1.0 that is tells how far along the transition to next page you are at.

Version:

SketchUp 6.0



330
331

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 330

def show_frame_at(seconds)
end

#size ⇒ `Integer`

The #size method is used to retrieve the number of pages.

Examples:

pages = Sketchup.active_model.pages
pages.add('Page 1')
pages.add('Page 2')
number = pages.size

Returns:

(Integer)

See Also:

#length

Version:

SketchUp 6.0



346
347

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 346

def size
end

#slideshow_time ⇒ `Object`

The slideshow_time method is used to get the amount of time that a slideshow of all of the pages will take. This takes into account the transition time for each Page and the amount of time that each Page is displayed.

Examples:

pages = Sketchup.active_model.pages
time = pages.slideshow_time

Returns:

status - true if successful

Version:

SketchUp 6.0



360
361

# File 'lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb', line 360

def slideshow_time
end

Class: Sketchup::Pages

Overview

Constant Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

Class Method Details

.add_frame_change_observer(object) ⇒ Integer

.remove_frame_change_observer(observer_id) ⇒ Boolean

Instance Method Details

#[](index_or_name) ⇒ Object

#add(name = nil, flags = PAGE_USE_ALL, index = self.size) ⇒ Sketchup::Page

#add_matchphoto_page(image_name, camera, page_name) ⇒ Object

#add_observer(observer) ⇒ Object

#count ⇒ Integer

#each {|page| ... } ⇒ Object

#erase(page) ⇒ Boolean

#length ⇒ Integer

#parent ⇒ Object

#remove_observer(observer) ⇒ Object

#selected_page ⇒ Object

#selected_page=(page) ⇒ Object

#show_frame_at(seconds) ⇒ Array(Sketchup::Page, Float)?

#size ⇒ Integer

#slideshow_time ⇒ Object

.add_frame_change_observer(object) ⇒ `Integer`

.remove_frame_change_observer(observer_id) ⇒ `Boolean`

#[](index_or_name) ⇒ `Object`

#add(name = nil, flags = PAGE_USE_ALL, index = self.size) ⇒ `Sketchup::Page`

#add_matchphoto_page(image_name, camera, page_name) ⇒ `Object`

#add_observer(observer) ⇒ `Object`

#count ⇒ `Integer`

#each {|page| ... } ⇒ `Object`

#erase(page) ⇒ `Boolean`

#length ⇒ `Integer`

#parent ⇒ `Object`

#remove_observer(observer) ⇒ `Object`

#selected_page ⇒ `Object`

#selected_page=(page) ⇒ `Object`

#show_frame_at(seconds) ⇒ `Array(Sketchup::Page, Float)`^?

#size ⇒ `Integer`

#slideshow_time ⇒ `Object`