Gravity Class

Gravity Class

Applies a gravity force to rigid bodies.

Inheritance Hierarchy

Namespace: DigitalRune.Physics.ForceEffects
Assembly: DigitalRune.Physics (in DigitalRune.Physics.dll) Version: 1.10.0.0 (1.10.0.14427)

Syntax

public class Gravity : ForceField

Public Class Gravity
	Inherits ForceField

public ref class Gravity : public ForceField

type Gravity =  
    class
        inherit ForceField
    end

The Gravity type exposes the following members.

Constructors

	Name	Description
	Gravity	Initializes a new instance of the Gravity class.
	Gravity(IAreaOfEffect)	Initializes a new instance of the Gravity class.

Methods

	Name	Description
	Apply	Applies the force effect to the specified body. (Overrides ForceFieldApply(RigidBody).)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAddToSimulation	Called when this force effect is added to a simulation. (Inherited from ForceEffect.)
	OnApply	Called when the simulation wants this force effect to apply forces to rigid bodies. (Inherited from ForceField.)
	OnDisabled	Called when this force effect was disabled. (Inherited from ForceEffect.)
	OnEnabled	Called when this force effect was enabled. (Inherited from ForceEffect.)
	OnRemoveFromSimulation	Called when this force effect is removed from a simulation. (Inherited from ForceEffect.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Properties

	Name	Description
	Acceleration	Gets or sets the gravity acceleration vector.
	AreaOfEffect	Gets or sets the area of effect. (Inherited from ForceField.)
	Enabled	Gets or sets a value indicating whether this ForceEffect is enabled. (Inherited from ForceEffect.)
	Simulation	Gets the simulation to which this force effect belongs. (Inherited from ForceEffect.)

Remarks

Gravity pulls all bodies into a predefined direction, which is usually "down".