HelpSource/Reference/Classes.schelp

   1 title:: Classes
   2 categories:: Language>OOP
   3 summary:: explaining classes
   4 related:: Classes/Class, Reference/Assignment, Guides/Intro-to-Objects, Reference/Messages, Guides/Polymorphism
   5
   6 All objects in SuperCollider are members of a class that describes the objects' data and interface. The name of a class must begin with a capital letter. Class names are the only global values in the SC language. Since classes are themselves objects, the value of a class name identifier is the object representing that class.
   7
   8 See link::Guides/Intro-to-Objects:: for an introduction to the concepts of classes, objects and messages.
   9
  10 section:: Instance Variables
  11
  12 The data of an object is contained in its instance variables. Instance variables are of two kinds, named and indexed. Each object contains a separate copy of its instance variables.
  13
  14 Some classes' instances have no instance variables at all but instead have an atomic value. Classes whose instances consist of an atomic value are link::Classes/Integer::, link::Classes/Float::, link::Classes/Symbol::, link::Classes/True::, link::Classes/False::, link::Classes/Nil::, link::Classes/Char::, link::Classes/Color::.
  15
  16 Instance variables declaration lists occur after the open curly bracket of the class definition and are preceeded by the reserved word code::var::. Instance variables names in the list may be initialized to a default literal value by using an equals sign. Instance variables which are not explicitly initialized will be set to nil. Instance variables that are immutable are defined by the reserved word code::const::.
  17
  18 Instance variables may only be directly accessed and changed from within the class' own methods. Instance variables may be exposed to clients by adding getter and setter messages to the class. A getter message is a message with the same name as the variable which returns the value of that variable when sent to the receiver. A setter message is a message with the name of the variable with an underscore appended which sets the value of the instance variable to the value of the argument to the message.
  19
  20 Getter and setter methods may be defined in the declaration of the instance variable. A getter message for an instance variable is created by typing a less than sign code::<:: before the variable name. A setter message is created by typing a greater than code::>:: sign before the variable name. If both occur then they must occur in the order code::<>::.
  21 code::
  22 var a, <b, >c, <>d;
  23 ::
  24 definitionlist::
  25 ## a || has no getter or setter.
  26 ## b || has a getter but not a setter.
  27 ## c || has only a setter.
  28 ## d || has both a getter and setter.
  29 ::
  30 code::
  31 Point {
  32         // x and y are instance variables which have both getter and setter methods
  33         // and default to zero.
  34         var <>x = 0, <>y = 0;
  35         ...
  36 }
  37
  38 p = Point.new;
  39 p.x_(5);                // send setter message to set x to 5
  40 p.y_(7);                // send setter message to set y to 7
  41 p.x = 5;                // send setter message using setter assignment
  42 p.y = 7;                // send setter message using setter assignment
  43 a = p.x;                // send getter message for x
  44 b = p.y;                // send getter message for y
  45 ::
  46
  47 section:: Class Variables
  48
  49 Class variables are values that are shared by all objects in the class. Class variable declaration lists are preceeded by the reserved word code::classvar:: and may be interspersed with instance variable declaration lists.
  50 Class variables like instance variables may only be directly accessed by methods of the class. Class variables may also have getter and setter methods created for them using the less than code::<:: and greater than code::>:: symbols.
  51
  52 section:: Instance Methods
  53
  54 The messages of a class' interface are implemented in the methods of the class. When an object is sent a message the method whose name matches the message selector in the receiver's class is executed.
  55
  56 Method definitions follow the class variable and instance variable declarations in the class.
  57
  58 Method definitions are similar to FunctionDefs in syntax. Method definitions begin with the message selector. The message selector must be an identifier or a binary operator. Methods have arguments and variable declarations with the same syntax as in FunctionDefs.
  59 Methods however have an implicit first argument named this which is the receiver of the message. The variable code::this:: may be referred to just like any of the other arguments and variables in the method. You may not assign a value to code::this::.
  60
  61 section:: Class Methods
  62
  63 Class Methods are methods that implement messages sent to the class object. A common example is the message new which is sent to the class object to create a new instance of the class. Class method names have an asterisk code::*:: preceeding the message selector.
  64
  65 section:: Determine the class of an object
  66 link::Classes/Object:: defines the method code::isKindOf:::
  67 code::
  68 anObject.isKindOf(aClass)
  69 ::
  70 It returns true if the object is of the class or one of its subclasses.
  71
  72 To determine if an object is specifically of type aClass, but not one of its subclasses, use the code::class:: instance variable and the identity equals sign:
  73 code::
  74 anObject.class === aClass
  75 ::
  76