Google SketchUp Ruby API

Introduction
- Getting Started
- Tutorials

Quick Reference

Object Reference
- App Level Classes
  - SketchUp
  - Model
  - AttributeDictionary
  - Animation
  - Camera
  - Color
  - Extension
  - Importer
  - OptionsManager
  - OptionsProvider
  - Set
  - TextureWriter
  - View
  - UVHelper
- Entity Classes
  - Entity
  - Drawingelement
  - ArcCurve
  - Behavior
  - ComponentDefinition
  - ComponentInstance
  - ConstructionLine
  - ConstructionPoint
  - Curve
  - Edge
  - EdgeUse
  - Face
  - Group
  - Image
  - Material
  - Layer
  - Loop
  - Page
  - SectionPlane
  - ShadowInfo
  - Style
  - Text
  - Texture
- Collection Classes
  - AttributeDictionaries
  - DefinitionList
  - Entities
  - Layers
  - Materials
  - Pages
  - RenderingOptions
  - Selection
  - Styles
  - Tools
- Geom Classes
  - Geom
  - BoundingBox
  - LatLong
  - Point3d
  - PolygonMesh
  - Vector3d
  - Vertex
  - Transformation
- UI Classes
  - UI
  - Command
  - InputPoint
  - PickHelper
  - Menu
  - Tool
  - Toolbar
  - WebDialog
- Observer Classes
- Core Ruby Classes
  - Array
  - Length
  - Numeric
  - String

Behavior

class

Parent: Entity

Introduction
Methods

Introduction

SketchUp 6.0+

The Behavior class is used to control the "behavior" of components, which roughly correlates to the series of options that you see in the Components dialog under the "edit" tab, such as whether it casts shadows, glues to walls, etc.

A Behavior object is accessed from a ComponentDefinition object, not created with a Behavior.new call.

     # Grab the Behavior object from the first component definition.
     model = Sketchup.active_model
     definition = model.definitions[0]
     behavior = definition.behavior

Methods

Behavior.always_face_camera=SketchUp 6.0+

The always_face_camera= method is used to set the always_face_camera behavior for a component.

If the always_face_camera behavior is true, a component will always try to orient itself so that the Y axis of the component is facing the camera.

Arguments:

setting: Sets the always_face_camera behavior to true or false.

Returns:

status: the status of the always_face_camera behavior.

 model = Sketchup.active_model
 behavior = model.definitions[0].behavior
 status = behavior.always_face_camera = false

Behavior.always_face_camera?SketchUp 6.0+

The always_face_camera? method is used to retrieve the always_face_camera behavior for a component.

If the always_face_camera behavior is true, then a component will always try to orient itself so that the -Y axis of the component is facing the camera.

Returns:

behavior: true if the component is set to always face the camera, false if the component is not set to always face camera.

 model = Sketchup.active_model
 # Returns a DefinitionList
 definitions = model.definitions
 path = Sketchup.find_support_file "Bed.skp",
   "Components/Components Sampler/"

 begin
   definition = definitions.load path
 rescue
   UI.messagebox $!.message
 end

 behavior = definition.behavior
 b = behavior.always_face_camera?
 if (b)
   UI.messagebox b
 else
   UI.messagebox "Always Face Camera is equal to false"
 end
 status = behavior.always_face_camera = true
 b = behavior.always_face_camera?
 if (b)
   UI.messagebox b
 else
   UI.messagebox "Failure"
 end

Behavior.cuts_opening=SketchUp 6.0+

The cuts_opening= method is used to set the cut opening behavior for a component.

Arguments:

setting: Sets the cuts_opening behavior to true or false.

Returns:

status: the status of the cuts_opening behavior (either true or false)

 model = Sketchup.active_model
 behavior = model.definitions[0].behavior
 status = behavior.cuts_opening = false
 if (status)
   # if status is true, print the status
   UI.messagebox status
 else
   # code to respond cuts_opening being false
 end

Behavior.cuts_opening?SketchUp 6.0+

The cuts_opening? method is used to get the status of a component's cut opening behavior.

Returns:

status: the status of the cuts_opening behavior (either true or false)

 model = Sketchup.active_model
 behavior = model.definitions[0].behavior
 status = behavior.cuts_opening?
 if (status)
   # if status is true, do something
 else
   # if status is false, do something else
 end

Behavior.is2d=SketchUp 6.0+

The is2d= method is used to set the 2D behavior for a component: whether it can be glued or aligned to a face.

Arguments:

setting: Sets the 2D behavior to true or false.

Returns:

status: the new setting

 model = Sketchup.active_model
 behavior = model.definitions[0].behavior
 status = behavior.is2d = false
 if (status)
   # if status is true, print the status
   UI.messagebox status
 else
   # code to respond is2d behavior being false
 end

Behavior.is2d?SketchUp 6.0+

The is2d? method is used to get a component's 2D behavior.

Returns:

status: the status of the 2D behavior (either true or false)

 model = Sketchup.active_model
 behavior = model.definitions[0].behavior
 status = behavior.is2d?
 if (status)
   # if status is true, do something
 else
   # if status is false, do something else
 end

Behavior.no_scale_mask=SketchUp 7.0+

Sets an integer that is really a bit-by-bit description of which scale tool handles are hidden on a given component. This is useful for creating definitions that can only be scaled in particular ways. If a bit contains a a 1, then a certain handle set will be hidden when the user selects the component and activates the Scale tool. Here is the map of which bits control which handles.

Bit0: disable scale along red (X),
Bit1: disable scale along green (Y),
Bit2: disable scale along blue (Z),
Bit3: disable scale in red/blue plane (X+Z),
Bit4: disable scale in green/blue plane (Y+Z),
Bit5: disable scale in red/green plane (X+Y),
Bit6: disable scale uniform (from corners) (XYZ).

Note that for 2-dimensional components (such as face-me components), not all of the handles in the list above are even used. Also, if the component you are modifying is already selected with the scale tool, then you or your user must deactivate and reactivate the scale tool for your new behavior to take effect.

Arguments:

scale_mask: An integer describing which scale tool handles are hidden.

Returns:

behavior: the Behavior object

 # Disable the green and red-axes handles by setting bits 1 and 2 to 1.
 definition = Sketchup.active_model.definitions[0]
 behavior = definition.behavior
 behavior.no_scale_mask = (1 << 1) + (1 << 2)

Behavior.no_scale_mask?SketchUp 7.0+

The no_scale_mask? method returns an integer that is a bit-by-bit description of which scale tool handles are hidden when the user selects this single component with the scale tool. See the no_scale_mask= method for details on the bit encodings used.

Returns:

scale_mask: an integer describing which scale tool handles are hidden.

 definition = Sketchup.active_model.definitions[0]
 behavior = definition.behavior
 no_scale_mask = behavior.no_scale_mask?

Behavior.shadows_face_sun=SketchUp 6.0+

The shadows_face_sun= method is used to identify whether the component's shadow will be cast from the component's current position as though the component were facing the sun. See the Component entity within the SketchUp User's guide for more information on this feature.

Arguments:

status: true if the component's is to be cast from the component's current position as though the component were facing the sun. False to cause the shadow to be cast from the component's current position.

Returns:

behavior: the Behavior object

 model = Sketchup.active_model
 behavior = model.definitions[0].behavior
 behavior = behavior.shadows_face_sun = true

Behavior.shadows_face_sun?SketchUp 6.0+

The shadows_face_sun? method is used to determine whether the component's shadow is being cast from the component's current position (as though the component were facing the sun). See the Component entity within the SketchUp User's guide for more information on this feature.

Returns:

status: true if the component's is to be cast from the component's current position as though the component were facing the sun. False to cause the shadow to be cast from the component's current position.

 model = Sketchup.active_model
 # Returns a DefinitionList
 definitions = model.definitions
 path = Sketchup.find_support_file "Bed.skp",
   "Components/Components Sampler/"
 begin
   definition = definitions.load path
 rescue
   UI.messagebox $!.message
 end

Behavior.snaptoSketchUp 6.0+

The snapto method is used to verify the status of a component's "snap to" behavior.

Returns a constant indicating the snapping behavior of the component described by behavior. Snapping behavior is how the x-y plane of a component instance will be snapped against a face. Possible values are:

SnapTo_Arbitrary => Snap to any aribrary face,
SnapTo_Horizontal => Snap to horizontal face like floors,
SnapTo_Vertical => Snap to vertical face like walls,
SnapTo_Sloped => Snap to sloped face like sloping roofs.

Returns:

status: the status of the snapto behavior (either true or false)

 model = Sketchup.active_model
 behavior = model.definitions[0].behavior
 status = behavior.snapto
 if (status)
   # if status is true, do something
 else
   # if status is false, do something else
 end

Behavior.snapto=SketchUp 6.0+

The snapto= method sets a component's "snap to" behavior.

Snapping behavior is how the x-y plane of a component instance will be snapped against a face. Possible constant values are:

SnapTo_Arbitrary => Snap to any aribrary face,
SnapTo_Horizontal => Snap to horizontal face like floors,
SnapTo_Vertical => Snap to vertical face like walls,
SnapTo_Sloped => Snap to sloped face like sloping roofs.

Arguments:

snapto: A numeric constant identifying one of the snapto types.

Returns:

behavior: the Behavior object

 model = Sketchup.active_model
 behavior = model.definitions[0].behavior
 behavior.snapto = SnapTo_Horizontal

Google SketchUp Ruby API

Introduction

Quick Reference

Object Reference

Behavior

class

Introduction

Methods