Class: MG::Scene

Inherits:
Node
  • Object
show all
Defined in:
doc/API_reference.rb

Overview

designed to be subclassed.

Instance Attribute Summary collapse

Attributes inherited from Node

#alpha, #anchor_point, #color, #name, #position, #rotation, #scale, #size, #z_index

Constructors collapse

Update Loop collapse

Events collapse

Instance Method Summary collapse

Methods inherited from Node

#add, #children, #clear, #delete, #delete_from_parent, #intersects?, #number_of_running_actions, #parent, #run_action, #schedule, #schedule_once, #stop_action, #stop_all_actions, #unschedule, #visible=, #visible?

Constructor Details

#initialize ⇒ Scene

The default initializer. Subclasses can construct the scene interface in this method, as well as providing an implementation for #update, then run the update loop by calling #start_update.



578
 
# File 'doc/API_reference.rb', line 578

def initialize; end

Instance Attribute Details

#gravity ⇒ Point

Returns the gravity of the scene’s physics world.

Returns:

  • (Point) —

    the gravity of the scene’s physics world.



643
644
645
 
# File 'doc/API_reference.rb', line 643

def gravity
  @gravity
end

Instance Method Details

#background_color=(color) ⇒ Object

Set background color for scene.

Parameters:

  • color (Color) —

    background color for scene.



654
 
# File 'doc/API_reference.rb', line 654

def background_color=(color); end

#debug_physics=(value) ⇒ Object

Set to draw the debug line.

Parameters:

  • value (Boolean) —

    true if draw debug lines.



650
 
# File 'doc/API_reference.rb', line 650

def debug_physics=(value); end

#debug_physics? ⇒ Boolean

Returns whether the physics engine should draw debug lines.

Returns:

  • (Boolean) —

    whether the physics engine should draw debug lines.



646
 
# File 'doc/API_reference.rb', line 646

def debug_physics?; end

#on_accelerate {|Events::Acceleration| ... } ⇒ self

Starts listening for accelerometer events on the receiver.

Yields:

  • (Events::Acceleration) —

    the given block will be yield when an accelerometer event is received from the device.

Returns:

  • (self) —

    the receiver.



631
 
# File 'doc/API_reference.rb', line 631

def on_accelerate; end

#on_contact_begin {|Events::PhysicsContact| ... } ⇒ self

Starts listening for contact begin events from the physics engine.

Yields:

  • (Events::PhysicsContact) —

    the given block will be yield when a contact event is received from the physics engine.

Returns:

  • (self) —

    the receiver.



637
 
# File 'doc/API_reference.rb', line 637

def on_contact_begin; end

#on_touch_begin {|Events::Touch| ... } ⇒ self

Starts listening for touch begin events on the receiver.

Yields:

  • (Events::Touch) —

    the given block will be yield when a touch begin event is received.

Returns:

  • (self) —

    the receiver.



607
 
# File 'doc/API_reference.rb', line 607

def on_touch_begin; end

#on_touch_cancel {|Events::Touch| ... } ⇒ self

Starts listening for touch cancel events on the receiver.

Yields:

  • (Events::Touch) —

    the given block will be yield when a touch cancel event is received.

Returns:

  • (self) —

    the receiver.



625
 
# File 'doc/API_reference.rb', line 625

def on_touch_cancel; end

#on_touch_end {|Events::Touch| ... } ⇒ self

Starts listening for touch end events on the receiver.

Yields:

  • (Events::Touch) —

    the given block will be yield when a touch end event is received.

Returns:

  • (self) —

    the receiver.



613
 
# File 'doc/API_reference.rb', line 613

def on_touch_end; end

#on_touch_move {|Events::Touch| ... } ⇒ self

Starts listening for touch move events on the receiver.

Yields:

  • (Events::Touch) —

    the given block will be yield when a touch move event is received.

Returns:

  • (self) —

    the receiver.



619
 
# File 'doc/API_reference.rb', line 619

def on_touch_move; end

#start_update ⇒ self

Starts the update loop. The #update method will be called on this object for every frame.

Returns:

  • (self) —

    the receiver.



586
 
# File 'doc/API_reference.rb', line 586

def start_update; end

#stop_update ⇒ self

Stops the update loop. The #update method will no longer be called on this object.

Returns:

  • (self) —

    the receiver.



591
 
# File 'doc/API_reference.rb', line 591

def stop_update; end

#update(delta) ⇒ self

The update loop method. Subclasses can provide a custom implementation of this method. The default implementation is empty.

Parameters:

  • delta (Float) —

    a value representing the amount of time, in seconds, since the last time this method was called.

Returns:

  • (self) —

    the receiver.



598
 
# File 'doc/API_reference.rb', line 598

def update(delta); end