Delta.PhysicsEngines.Farseer.xml

/Dlls/Delta.PhysicsEngines.Farseer.xml

#
XML | 412 lines | 412 code | 0 blank | 0 comment | 0 complexity | c36340d53ad6b5c27f68add8a8e28483 MD5 | raw file
Possible License(s): Apache-2.0

<?xml version="1.0"?>

<doc>

    <assembly>

        <name>Delta.PhysicsEngines.Farseer</name>

    </assembly>

    <members>

        <member name="T:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping">

            <summary>

            Class that managed mapping from-to Delta engine data types to farseer and

            vice versa.

            </summary>

            <remarks>

            Note: Farseer uses internally Microsoft.Xna.Vector2 inside but this does

            not mean that it self references XNA. They ported the XNA version inside

            Farseer.

            </remarks>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Convert Delta Engine Vector to Farseer Vector2.

            </summary>

            <param name="vector">The vector.</param>

            <returns>Farseer Vector2 created from Delta Engine Point.</returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(Delta.Utilities.Datatypes.Point@)">

            <summary>

            Convert Delta Engine Point to Farseer Vector2.

            </summary>

            <param name="point">The point.</param>

            <returns>Farseer Vector2 created from Delta Engine Point.</returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(Microsoft.Xna.Framework.Vector2,Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Convert Farseer Vector2 to Delta engine vector.

            </summary>

            <param name="vector">The vector.</param>

            <param name="result">The converted Farseer vector.</param>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(Microsoft.Xna.Framework.Vector2@,Delta.Utilities.Datatypes.Point@)">

            <summary>

            Convert Farseer Vector2 to Delta engine Point.

            </summary>

            <param name="vector">The vector.</param>

            <param name="result">The converted Farseer vector.</param>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(System.Collections.Generic.IList{Delta.Utilities.Datatypes.Point})">

            <summary>

            Converts a list of DeltaEngine Point's to Farseer list of Point's.

            </summary>

            <param name="list">The list.</param>

            <returns>

            Farseer List of Vector2 created from Delta Engine list of points.

            </returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(System.Collections.Generic.List{System.Collections.Generic.IList{Delta.Utilities.Datatypes.Point}})">

            <summary>

            Convers a list of list Point to Farseer Vertices.

            </summary>

            <param name="arrayVert">The array vert.</param>

            <returns>

            Farseer Vertices created from Delta Engine list of points.

            </returns>

        </member>

        <member name="T:Delta.PhysicsEngines.Farseer.FarseerBody">

            <summary>

            Farseer body implementation.

            </summary>

        </member>

        <member name="F:Delta.PhysicsEngines.Farseer.FarseerBody.DefaultBoundingBox">

            <summary>

            Default bounding box.

            TODO: this is not used anywhere yet, fix this!

            </summary>

        </member>

        <member name="F:Delta.PhysicsEngines.Farseer.FarseerBody.farseerBody">

            <summary>

            Farseer body.

            </summary>

        </member>

        <member name="F:Delta.PhysicsEngines.Farseer.FarseerBody.farseerFixtures">

            <summary>

            List of Farseer fixtures.

            </summary>

        </member>

        <member name="F:Delta.PhysicsEngines.Farseer.FarseerBody.physicsManager">

            <summary>

            Our Farseer physics implementation.

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.#ctor(Delta.PhysicsEngines.Farseer.FarseerPhysics,Delta.PhysicsEngines.PhysicsShape,Delta.Utilities.Datatypes.Vector)">

            <summary>

            Initializes a new instance of the <see cref="T:Delta.PhysicsEngines.Farseer.FarseerBody"/> class.

            </summary>

            <param name="physicsManager">The physics manager.</param>

            <param name="shape">The shape.</param>

            <param name="initialPosition">Body initial position.</param>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.Dispose">

            <summary>

            Handle disposing.

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.ApplyForce(Delta.Utilities.Datatypes.Vector)">

            <summary>

            Applies a force at the center of mass.

            </summary>

            <param name="force">

            Vector containing force data to apply to body in 3D space.

            </param>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.ApplyForce(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">

            <summary>

            Apply a force at a world point. If the force is not

            applied at the center of mass, it will generate a torque and

            affect the angular velocity. This wakes up the body.

            </summary>

            <param name="force">

            Vector containing force data to apply to body in 3D space.

            </param>

            <param name="position">

            Relative position from where to apply force.

            </param>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.ApplyTorque(Delta.Utilities.Datatypes.Vector)">

            <summary>

            Apply a torque. This affects the angular velocity without affecting the

            linear velocity of the center of mass.

            </summary>

            <remarks>

            This wakes up the body.

            </remarks>

            <param name="torque">

            Vector containing torque data for both 2D and 3D shapes.

            </param>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.ApplyLinearImpulse(Delta.Utilities.Datatypes.Vector)">

            <summary>

            Apply an impulse at a point. This immediately modifies the velocity.

            </summary>

            <remarks>

            This wakes up the body.

            </remarks>

            <param name="impulse">The impulse vector in 3D space.</param>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.ApplyLinearImpulse(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">

            <summary>

            Apply an impulse at a point. This immediately modifies the velocity.

            It also modifies the angular velocity if the point of application

            is not at the center of mass.

            </summary>

            <remarks>

            This wakes up the body.

            </remarks>

            <param name="impulse">The impulse vector in 3D space.</param>

            <param name="position">Relative position from where to apply.</param>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.Remove">

            <summary>

            Remove

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.CreateShape">

            <summary>

            Creates shape from given properties.

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.GetSafeFloat(System.Collections.Generic.Dictionary{Delta.PhysicsEngines.PhysicsShape.PropertyType,System.Object},Delta.PhysicsEngines.PhysicsShape.PropertyType)">

            <summary>

            Private helper method to get a float value from the properties.

            </summary>

            <param name="properties">Shape properties.</param>

            <param name="type">Property type to get.</param>

            <returns>Float value from the properties.</returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.CreateGear(System.Single,System.Int32,System.Single,System.Single,System.Single,FarseerPhysics.Dynamics.Body)">

            <summary>

            Helper method for creating gear fixture list.

            </summary>

            <param name="radius">The radius.</param>

            <param name="numberOfTeeth">The number of teeth.</param>

            <param name="tipPercentage">The tip percentage.</param>

            <param name="toothHeight">Height of the tooth.</param>

            <param name="density">The density.</param>

            <param name="body">The body.</param>

            <returns>List containing all fixtures used for Gear shape.</returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.OnColliding(FarseerPhysics.Dynamics.Fixture,FarseerPhysics.Dynamics.Fixture,FarseerPhysics.Dynamics.Contacts.Contact)">

            <summary>

            On colliding farseeer handle event. 

            </summary>

            <param name="fixtureA">Farseer fixture A.</param>

            <param name="fixtureB">Farseer fixture B.</param>

            <param name="contacts">Farseer contact data.</param>

            <returns>True to response on farseer collision event.</returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.Initialize">

            <summary>

            Initialize

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.GetDebugInfo">

            <summary>

            Return optional debug information text with details about this body!

            </summary>

            <returns>Extra information about inertia, flags, etc.</returns>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Body">

            <summary>

            Gets the Farseer native body (read-only).

            </summary>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Position">

            <summary>

            Position given in world space.

            </summary>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Position2D">

            <summary>

            Position 2D

            </summary>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Rotation">

            <summary>

            Rotation angle in degrees for 2D bodies.

            </summary>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.LinearVelocity">

            <summary>

            The velocity of the body.

            </summary>

            <value>

            The linear velocity.

            </value>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.AngularVelocity">

            <summary>

            Gets or Sets the angular velocity of the body.

            </summary>

            <remarks>

            For 2D physics simulation only X component is used.

            </remarks>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.AngularVelocity2D">

            <summary>

            Angular velocity 2D as a float, for 2D only the .x component is used!

            </summary>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Mass">

            <summary>

            Gets or sets the mass. Usually in kilograms (kg).

            </summary>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Restitution">

            <summary>

            Gets the restitution of the body.

            </summary>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.BoundingBox">

            <summary>

            Gets the BoundingBox of the body.

            </summary>

        </member>

        <member name="T:Delta.PhysicsEngines.Farseer.FarseerPhysics">

            <summary>

            Farseer3 physics manager for 2D physics

            </summary>

        </member>

        <member name="F:Delta.PhysicsEngines.Farseer.FarseerPhysics.ScaleFactor">

            <summary>

            Scale factor used for precision between DeltaEngine draw system and

            Farseer. This is important because Farseer thinks in pixels and the

            quadratic space between 0 and 1 is not enough precision for most

            Farseer operations. The ScaleFactor helps to scale quadratic space

            up to 1000 units for Farseer and to make all methods work correctly.

            </summary>

        </member>

        <member name="F:Delta.PhysicsEngines.Farseer.FarseerPhysics.InvScaleFactor">

            <summary>

            Inverse of ScaleFactor (1.0f / ScaleFactor)

            </summary>

        </member>

        <member name="F:Delta.PhysicsEngines.Farseer.FarseerPhysics.farseerPhysicsWorld">

            <summary>

            Farseer Physic World.

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.#ctor">

            <summary>

            Constructor

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.IsShapeSupported(Delta.PhysicsEngines.Enums.ShapeType)">

            <summary>

            Gets whether the current physics module supports given shape type.

            </summary>

            <param name="shapeType">Type of the shape.</param>

            <returns>

              <c>true</c> if [is shape supported] [the specified shape type]; otherwise, <c>false</c>.

            </returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.IsJointSupported(Delta.PhysicsEngines.Enums.JointType)">

            <summary>

            Gets whether the current physics module supports given joint type.

            </summary>

            <param name="shapeType">Type of the shape.</param>

            <returns>

              <c>true</c> if [is joint supported] [the specified shape type]; otherwise, <c>false</c>.

            </returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.IsFeatureSupported(Delta.PhysicsEngines.Enums.FeatureSupport)">

            <summary>

            Gets whether the current physics module supports given feature.

            </summary>

            <param name="support">The support.</param>

            <returns>

              <c>true</c> if the specific feature is supported, <c>false</c> otherwise.

            </returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.SetGroundPlane(System.Boolean,System.Single)">

            <summary>

            Implementation of SetGroundPlane

            </summary>

            <param name="enable">True to enable, false otherwise.</param>

            <param name="height">The height of the plane.</param>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.RayCastImpl(Delta.Utilities.Datatypes.Ray,System.Boolean,Delta.PhysicsEngines.PhysicsBody@,Delta.Utilities.Datatypes.Vector@,System.Single@,System.Object@)">

            <summary>

            Rays the cast impl.

            </summary>

            <param name="ray">The ray.</param>

            <param name="foundBody">The found body.</param>

            <param name="surfaceNormal">The surface normal.</param>

            <param name="fraction">The fraction.</param>

            <param name="userData">The user data.</param>

            <param name="checkGround">Whether to perform ray cast on 2D ground too.</param>

            <returns>True if any intersection happen, false otherwise.</returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.RayCastImpl2D(Delta.Utilities.Datatypes.Point,Delta.Utilities.Datatypes.Point,Delta.PhysicsEngines.PhysicsBody@,Delta.Utilities.Datatypes.Point@,System.Single@)">

            <summary>

            Rays the cast impl 2D.

            </summary>

            <param name="point1">The point1.</param>

            <param name="point2">The point2.</param>

            <param name="outBody">The out body.</param>

            <param name="normal">The normal.</param>

            <param name="fraction">The fraction.</param>

            <returns>True if any intersection was found.</returns>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.UpdateSimulation(System.Single)">

            <summary>

            Perform Farseer simulation step.

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.FindBodyByFixture(FarseerPhysics.Dynamics.Fixture)">

            <summary>

            Find a farseer object by body.

            </summary>

            <param name="fixtureToFind">Farseer fixture to search for.</param>

            <returns>Farseer physics body or null if not found.</returns>

        </member>

        <member name="T:Delta.PhysicsEngines.Farseer.FarseerPhysics.FarseerPhysicsTests">

            <summary>

            Tests

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.FarseerPhysicsTests.TestInitialization">

            <summary>

            Test whether initialization has been done.

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.FarseerPhysicsTests.TestCreate2DBodyWithShape">

            <summary>

            Test creation of 2D body with shape.

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.FarseerPhysicsTests.TestFeatureSupport">

            <summary>

            Test whether given feature is supoorted.

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.FarseerPhysicsTests.TestShapeSupport">

            <summary>

            Test whether given shape is supoorted.

            </summary>

        </member>

        <member name="T:Delta.PhysicsEngines.Farseer.FarseerJoint">

            <summary>

            Farseer joint implementation.

            </summary>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerJoint.#ctor(Delta.PhysicsEngines.Farseer.FarseerPhysics,Delta.PhysicsEngines.Enums.JointType,Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,System.Object[])">

            <summary>

            Creates a new instance of the <see cref="T:Delta.PhysicsEngines.Farseer.FarseerJoint"/> class.

            </summary>

            <param name="physicsManager">The physics manager.</param>

            <param name="jointType">Type of the joint.</param>

            <param name="bodyA">The body A.</param>

            <param name="bodyB">The body B.</param>

            <param name="args">The args.</param>

        </member>

        <member name="M:Delta.PhysicsEngines.Farseer.FarseerJoint.CreateJoint">

            <summary>

            Create joint from properties.

            </summary>

        </member>

        <member name="P:Delta.PhysicsEngines.Farseer.FarseerJoint.Joint">

            <summary>

            Gets farseer joint object.

            </summary>

        </member>

    </members>

</doc>