Parent

Shade

Author

Manuela Ruiz (mruiz@lcc.uma.es)

This class wrapps some global variables, including the current project

Public Class Methods

add_constraint_class_name(constraint_class_name) click to toggle source
constraint_class_name

a String with the name for a new constraint class

Adds the new name to the list of taken constraint class names

      # File lib/main-structures.rb, line 1735
1735:         def Shade.add_constraint_class_name(constraint_class_name)

1736:                 @@constraint_class_names.push constraint_class_name

1737:         end
add_goal_class_name(goal_class_name) click to toggle source
goal_class_name

a String with the name for a new goal class

Adds the new name to the list of taken goal class names

      # File lib/main-structures.rb, line 1754
1754:         def Shade.add_goal_class_name(goal_class_name)

1755:                 @@goal_class_names.push goal_class_name

1756:         end
constraint_class_names() click to toggle source
returns

the current constraint class names list

      # File lib/main-structures.rb, line 1747
1747:         def Shade.constraint_class_names

1748:                 return @@constraint_class_names

1749:         end
constraint_class_names=(constraint_class_names) click to toggle source
constraint_class_names

an Array of Strings with all the taken constraint class names

Sets the constraint class names list to the specified one

      # File lib/main-structures.rb, line 1742
1742:         def Shade.constraint_class_names=(constraint_class_names)

1743:                 @@constraint_class_names = constraint_class_names

1744:         end
goal_class_names() click to toggle source
returns

the current goal class names list

      # File lib/main-structures.rb, line 1766
1766:         def Shade.goal_class_names

1767:                 return @@goal_class_names

1768:         end
goal_class_names=(goal_class_names) click to toggle source
goal_class_names

an Array of Strings with all the taken goal class names

Sets the goal class names list to the specified one

      # File lib/main-structures.rb, line 1761
1761:         def Shade.goal_class_names=(goal_class_names)

1762:                 @@goal_class_names = goal_class_names

1763:         end
label_radius() click to toggle source
returns

the current label radius

      # File lib/main-structures.rb, line 1728
1728:         def Shade.label_radius

1729:                 return @@label_radius

1730:         end
label_radius=(label_radius) click to toggle source
label_radius

the desired radius, in meters, for the labels

Sets the label radius to the specified value

      # File lib/main-structures.rb, line 1723
1723:         def Shade.label_radius=(label_radius)

1724:                 @@label_radius = label_radius

1725:         end
project() click to toggle source
returns

the current Project object

      # File lib/main-structures.rb, line 1685
1685:         def Shade.project

1686:                 return @@project

1687:         end
project=(project) click to toggle source
project

a Project object

Sets the project

      # File lib/main-structures.rb, line 1692
1692:         def Shade.project=(project)

1693:                 @@project = project

1694:         end
robot() click to toggle source
returns

the curren robot. If no robot has been loaded, it returns nil

      # File lib/main-structures.rb, line 1778
1778:         def Shade.robot

1779:                 return @@robot

1780:         end
robot=(robot) click to toggle source
robot

a Robot object for project scripting

Sets the current robot to the specified one

      # File lib/main-structures.rb, line 1773
1773:         def Shade.robot=(robot)

1774:                 @@robot = robot

1775:         end
rule_groups_observer() click to toggle source
returns

the RuleGroupsObserver object

      # File lib/main-structures.rb, line 1697
1697:         def Shade.rule_groups_observer

1698:                 return @@rule_groups_observer

1699:         end
rule_groups_observer=(rule_groups_observer) click to toggle source
rule_groups_observer

a RuleGroupsObserver object

Sets the rule groups observer

      # File lib/main-structures.rb, line 1704
1704:         def Shade.rule_groups_observer=(rule_groups_observer)

1705:                 @@rule_groups_observer = rule_groups_observer

1706:         end
show_text() click to toggle source
returns

the flag show_text

      # File lib/main-structures.rb, line 1709
1709:         def Shade.show_text

1710:                 return @@show_text

1711:         end
show_text=(show_text) click to toggle source
show_text

true iff text is to be shown in the SketchUp canvas (titles for the project and the grammar)

Sets the show_text flag

      # File lib/main-structures.rb, line 1716
1716:         def Shade.show_text=(show_text)

1717:                 @@show_text = show_text

1718:         end
using_sketchup() click to toggle source
returns

true if SketchUp is being used

      # File lib/main-structures.rb, line 1673
1673:         def Shade.using_sketchup

1674:                 return @@using_sketchup

1675:         end
using_sketchup=(using_sketchup) click to toggle source
using_sketchup

true if SketchUp is being used

Sets the flag using_sketchup to the specified value

      # File lib/main-structures.rb, line 1680
1680:         def Shade.using_sketchup=(using_sketchup)

1681:                 @@using_sketchup = using_sketchup

1682:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.