Class: Layout::Group
- Defined in:
- lib/sketchup-api-stubs/stubs/Layout/Group.rb
Overview
A group is a special type of Entity that does not belong to a Layer and contains other Entitys as children. A Group‘s children may include other Groups, allowing for a hierarchical tree structure of Entitys. A Group must contain at least one child and will be automatically collapsed if an operation is performed that results in the Group being empty.
Constant Summary collapse
- RESIZE_BEHAVIOR_BOUNDS =
Constants
nil
- RESIZE_BEHAVIOR_BOUNDS_AND_FONTS =
Stub value.
nil
- RESIZE_BEHAVIOR_NONE =
Stub value.
nil
Instance Method Summary collapse
- #entities ⇒ Layout::Entities
-
#initialize(entities) ⇒ Layout::Group
constructor
The #initialize method creates a new Group.
-
#remove_scale_factor(resize_behavior) ⇒ Object
The #remove_scale_factor method removes the scale factor from the Group.
-
#scale_factor ⇒ Float?
The #scale_factor method returns the the scale factor associated with the Group.
-
#scale_precision ⇒ Float
The #scale_precision method returns the precision used for the scale of the Group.
-
#scale_precision=(precision) ⇒ Object
The #scale_precision= method sets the precision for the scale of the Group.
-
#scale_units ⇒ Integer
The #scale_units method returns the units format used in the scale for the Group.
-
#scale_units=(units_format) ⇒ Object
The #scale_units= method sets the the units format for the scale of the Group.
-
#set_scale_factor(scale_factor, units_format, resize_behavior) ⇒ Object
The #set_scale_factor method sets the the scale factor for the Group.
- #ungroup ⇒ Boolean
Methods inherited from Entity
#==, #bounds, #document, #drawing_bounds, #group, #layer_instance, #locked=, #locked?, #move_to_group, #move_to_layer, #on_shared_layer?, #page, #style, #style=, #transform!, #transformation, #untransformed_bounds, #untransformed_bounds=
Constructor Details
#initialize(entities) ⇒ Layout::Group
The #initialize method creates a new Layout::Group.
67 68 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Group.rb', line 67 def initialize(entities) end |
Instance Method Details
#entities ⇒ Layout::Entities
The #entities method returns the Entities that belong to the Layout::Group.
33 34 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Group.rb', line 33 def entities end |
#remove_scale_factor(resize_behavior) ⇒ Object
The #remove_scale_factor method removes the scale factor from the Layout::Group.
The resize behavior can be one of the following values:
Layout::Group::RESIZE_BEHAVIOR_NONE
Layout::Group::RESIZE_BEHAVIOR_BOUNDS
Layout::Group::RESIZE_BEHAVIOR_BOUNDS_AND_FONTS
92 93 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Group.rb', line 92 def remove_scale_factor(resize_behavior) end |
#scale_factor ⇒ Float?
The #scale_factor method returns the the scale factor associated with the Layout::Group.
106 107 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Group.rb', line 106 def scale_factor end |
#scale_precision ⇒ Float
The #scale_precision method returns the precision used for the scale of the Layout::Group.
120 121 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Group.rb', line 120 def scale_precision end |
#scale_precision=(precision) ⇒ Object
LayOut only allows for a finite set of precision values for each units setting, so it will set the precision to the closest valid setting for the specified units. See the “Units” section of LayOut’s “Document Setup” dialog for a reference of the available precisions for each units setting.
The #scale_precision= method sets the precision for the scale of the Layout::Group.
141 142 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Group.rb', line 141 def scale_precision=(precision) end |
#scale_units ⇒ Integer
The #scale_units method returns the units format used in the scale for the Layout::Group.
The units format can be any of the following values:
- Layout::Document::FRACTIONAL_INCHES
- Layout::Document::DECIMAL_INCHES
- Layout::Document::DECIMAL_FEET
- Layout::Document::DECIMAL_MILLIMETERS
- Layout::Document::DECIMAL_CENTIMETERS
- Layout::Document::DECIMAL_METERS
- Layout::Document::DECIMAL_POINTS
- Layout::Document::DECIMAL_INCHES
166 167 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Group.rb', line 166 def scale_units end |
#scale_units=(units_format) ⇒ Object
The #scale_units= method sets the the units format for the scale of the Layout::Group.
The units format can be any of the following values:
- Layout::Document::FRACTIONAL_INCHES
- Layout::Document::DECIMAL_INCHES
- Layout::Document::DECIMAL_FEET
- Layout::Document::DECIMAL_MILLIMETERS
- Layout::Document::DECIMAL_CENTIMETERS
- Layout::Document::DECIMAL_METERS
- Layout::Document::DECIMAL_POINTS
- Layout::Document::DECIMAL_INCHES
197 198 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Group.rb', line 197 def scale_units=(units_format) end |
#set_scale_factor(scale_factor, units_format, resize_behavior) ⇒ Object
The #set_scale_factor method sets the the scale factor for the Layout::Group.
The units format can be any of the following values:
- Layout::Document::FRACTIONAL_INCHES
- Layout::Document::DECIMAL_INCHES
- Layout::Document::DECIMAL_FEET
- Layout::Document::DECIMAL_MILLIMETERS
- Layout::Document::DECIMAL_CENTIMETERS
- Layout::Document::DECIMAL_METERS
- Layout::Document::DECIMAL_POINTS
- Layout::Document::DECIMAL_INCHES
-
The resize behavior can be one of the following values:
Layout::Group::RESIZE_BEHAVIOR_NONE
Layout::Group::RESIZE_BEHAVIOR_BOUNDS
Layout::Group::RESIZE_BEHAVIOR_BOUNDS_AND_FONTS
242 243 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Group.rb', line 242 def set_scale_factor(scale_factor, units_format, resize_behavior) end |
#ungroup ⇒ Boolean
The #ungroup method removes all Entitys from the Layout::Group and deletes the Layout::Group.
258 259 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Group.rb', line 258 def ungroup end |