Class: MSPhysics::Gear

Inherits:

Entity

• Object
• Entity
• MSPhysics::Gear

Defined in:

RubyExtension/MSPhysics/gear.rb

Overview

Since:

• 1.0.0

Constant Summary

DEFAULT_RATIO =

Since:

• 1.0.0

1.0

Class Method Summary

• .all_gears ⇒ Array<Gear>

  Get all gears.

• .gear_by_address(address) ⇒ Gear^?

  Get gear by address.

• .validate(gear, world = nil) ⇒ void private

  Verify that gear is valid.

Instance Method Summary

• #address ⇒ Fixnum

  Get pointer the gear.

• #destroy ⇒ void

  Destroy gear.

• #initialize(world, joint1, joint2) ⇒ Gear constructor

  A new instance of Gear.

• #joint1 ⇒ MSPhysics::Joint

  Get the first joint the gear is linked to.

• #joint2 ⇒ MSPhysics::Joint

  Get the second joint the gear is linked to.

• #ratio ⇒ Numeric

  Get gear ratio.

• #ratio=(value) ⇒ Object

  Set gear ratio.

• #valid? ⇒ Boolean

  Determine whether gear is valid.

• #world ⇒ MSPhysics::World

  Get the world the gear is associated to.

Methods inherited from Entity

#inspect, #to_s

Constructor Details

#initialize(world, joint1, joint2) ⇒ Gear

Returns a new instance of Gear

Parameters:

• world (MSPhysics::World)
• joint1 (MSPhysics::Joint)
• joint2 (MSPhysics::Joint)

Since:

• 1.0.0

Class Method Details

.all_gears ⇒ Array<Gear>

Note:

Gears that do not have a MSPhysics::Gear instance are not included in the array.

Get all gears.

Returns:

• (Array<Gear>)

Since:

• 1.0.0

.gear_by_address(address) ⇒ Gear^?

Get gear by address.

Parameters:

• address (Fixnum)

Returns:

• (Gear, nil) —

  A Gear object if successful.

Raises:

• (TypeError) —

  if the address is invalid.

Since:

• 1.0.0

.validate(gear, world = nil) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Verify that gear is valid.

Parameters:

• gear (Gear)
• world (World, nil) (defaults to: nil) —

  A world the gear ought to belong to or nil.

Raises:

• (TypeError) —

  if gear is invalid or destroyed.

Since:

• 1.0.0

Instance Method Details

#address ⇒ Fixnum

Get pointer the gear.

Returns:

• (Fixnum)

Since:

• 1.0.0

#destroy ⇒ void

This method returns an undefined value.

Destroy gear.

Since:

• 1.0.0

#joint1 ⇒ MSPhysics::Joint

Get the first joint the gear is linked to.

Returns:

• (MSPhysics::Joint)

Since:

• 1.0.0

#joint2 ⇒ MSPhysics::Joint

Get the second joint the gear is linked to.

Returns:

• (MSPhysics::Joint)

Since:

• 1.0.0

#ratio ⇒ Numeric

Get gear ratio.

Returns:

• (Numeric)

Since:

• 1.0.0

#ratio=(value) ⇒ Object

Set gear ratio.

Parameters:

• value (Numeric)

Since:

• 1.0.0

#valid? ⇒ Boolean

Determine whether gear is valid.

Returns:

• (Boolean)

Since:

• 1.0.0

#world ⇒ MSPhysics::World

Get the world the gear is associated to.

Returns:

• (MSPhysics::World)

Since:

• 1.0.0