Class: Sketchup::Behavior
- Defined in:
- lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb
Overview
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.
Instance Method Summary collapse
-
#always_face_camera=(setting) ⇒ Object
The always_face_camera= method is used to set the always_face_camera behavior for a component.
-
#always_face_camera? ⇒ Boolean
The always_face_camera? method is used to retrieve the always_face_camera behavior for a component.
-
#cuts_opening=(setting) ⇒ Object
The cuts_opening= method is used to set the cut opening behavior for a component.
-
#cuts_opening? ⇒ Boolean
The cuts_opening? method is used to get the status of a component’s cut opening behavior.
-
#is2d=(is2d) ⇒ Object
The #is2d= method is used to set whether the component can glue to other entities or not.
-
#is2d? ⇒ Boolean
The #is2d? method is used to get whether the component can glue to other entities or not.
-
#no_scale_mask=(scale_mask) ⇒ Object
Sets an integer that is really a bit-by-bit description of which scale tool handles are hidden on a given component.
-
#no_scale_mask? ⇒ Boolean
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.
-
#shadows_face_sun=(status) ⇒ Object
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.
-
#shadows_face_sun? ⇒ Boolean
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).
-
#snapto ⇒ Integer
The #snapto method is used to see how a component can glue to other entities.
-
#snapto=(snapto) ⇒ Object
The #snapto= method is used to set how a component can glue to other entities.
Methods inherited from Entity
#add_observer, #attribute_dictionaries, #attribute_dictionary, #delete_attribute, #deleted?, #entityID, #get_attribute, #inspect, #model, #parent, #persistent_id, #remove_observer, #set_attribute, #to_s, #typename, #valid?
Instance Method Details
#always_face_camera=(setting) ⇒ Object
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.
40 41 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 40 def always_face_camera=(setting) end |
#always_face_camera? ⇒ Boolean
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.
82 83 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 82 def always_face_camera? end |
#cuts_opening=(setting) ⇒ Object
To enable cut opening, also set #is2d= to true.
The cuts_opening= method is used to set the cut opening behavior for a component.
102 103 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 102 def cuts_opening=(setting) end |
#cuts_opening? ⇒ Boolean
The cuts_opening? method is used to get the status of a component’s cut opening behavior.
116 117 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 116 def cuts_opening? end |
#is2d=(is2d) ⇒ Object
The #is2d= method is used to set whether the component can glue to other entities or not.
130 131 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 130 def is2d=(is2d) end |
#is2d? ⇒ Boolean
The #is2d? method is used to get whether the component can glue to other entities or not.
147 148 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 147 def is2d? end |
#no_scale_mask=(scale_mask) ⇒ Object
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.
184 185 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 184 def no_scale_mask=(scale_mask) end |
#no_scale_mask? ⇒ Boolean
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.
201 202 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 201 def no_scale_mask? end |
#shadows_face_sun=(status) ⇒ Object
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.
223 224 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 223 def shadows_face_sun=(status) end |
#shadows_face_sun? ⇒ Boolean
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.
249 250 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 249 def shadows_face_sun? end |
#snapto ⇒ Integer
The #snapto method is used to see how a component can glue to other entities.
Returns a value indicating the snapping behavior of the component. 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 arbitrary 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.
272 273 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 272 def snapto end |
#snapto=(snapto) ⇒ Object
To enable gluing, also set #is2d= to true.
To disable gluing, set #is2d= to false.
The #snapto= method is used to set how a component can glue to other entities.
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 arbitrary 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.
299 300 |
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb', line 299 def snapto=(snapto) end |