PlayRho  1.1.0
An Interactive Real-Time-Oriented C++ Physics Engine & Library
Physical Quantity Types

Types for physical quantities. More...

Typedefs

using playrho::Time = PLAYRHO_QUANTITY(boost::units::si::time)
 Time quantity. More...
 
using playrho::Frequency = PLAYRHO_QUANTITY(boost::units::si::frequency)
 Frequency quantity. More...
 
using playrho::Length = PLAYRHO_QUANTITY(boost::units::si::length)
 Length quantity. More...
 
using playrho::LinearVelocity = PLAYRHO_QUANTITY(boost::units::si::velocity)
 Linear velocity quantity. More...
 
using playrho::LinearAcceleration = PLAYRHO_QUANTITY(boost::units::si::acceleration)
 Linear acceleration quantity. More...
 
using playrho::Mass = PLAYRHO_QUANTITY(boost::units::si::mass)
 Mass quantity. More...
 
using playrho::InvMass = PLAYRHO_QUANTITY(playrho::units::si::inverse_mass)
 Inverse mass quantity. More...
 
using playrho::Area = PLAYRHO_QUANTITY(boost::units::si::area)
 Area quantity. More...
 
using playrho::AreaDensity = PLAYRHO_QUANTITY(boost::units::si::surface_density)
 Area (surface) density quantity. More...
 
using playrho::Angle = PLAYRHO_QUANTITY(boost::units::si::plane_angle)
 Angle quantity. More...
 
using playrho::AngularVelocity = PLAYRHO_QUANTITY(boost::units::si::angular_velocity)
 Angular velocity quantity. More...
 
using playrho::AngularAcceleration = PLAYRHO_QUANTITY(boost::units::si::angular_acceleration)
 Angular acceleration quantity. More...
 
using playrho::Force = PLAYRHO_QUANTITY(boost::units::si::force)
 Force quantity. More...
 
using playrho::Torque = PLAYRHO_QUANTITY(boost::units::si::torque)
 Torque quantity. More...
 
using playrho::SecondMomentOfArea = PLAYRHO_QUANTITY(playrho::units::si::second_moment_of_area)
 Second moment of area quantity. More...
 
using playrho::RotInertia = PLAYRHO_QUANTITY(boost::units::si::moment_of_inertia)
 Rotational inertia quantity. More...
 
using playrho::InvRotInertia = PLAYRHO_QUANTITY(playrho::units::si::inverse_moment_of_inertia)
 Inverse rotational inertia quantity. More...
 
using playrho::Momentum = PLAYRHO_QUANTITY(boost::units::si::momentum)
 Momentum quantity. More...
 
using playrho::AngularMomentum = PLAYRHO_QUANTITY(boost::units::si::angular_momentum)
 Angular momentum quantity. More...
 

Detailed Description

Types for physical quantities.

These are the type aliases for physical quantities like time and length that are used by the PlayRho library. Conceptually a given quantity is only expressable in the units that are defined for that quantity.

See also
Units For Physical Quantities
https://en.wikipedia.org/wiki/List_of_physical_quantities

Typedef Documentation

◆ Angle

using playrho::Angle = typedef PLAYRHO_QUANTITY(boost::units::si::plane_angle)

Angle quantity.

This is the type alias for the plane angle base quantity.

Note
This quantity's dimension is: plane angle (QP).
See also
Radian, Degree.

◆ AngularAcceleration

using playrho::AngularAcceleration = typedef PLAYRHO_QUANTITY(boost::units::si::angular_acceleration)

Angular acceleration quantity.

This is the type alias for the angular acceleration quantity. It's a derived quantity.

Note
This quantity's dimensions are: plane angle per time squared (QP T^-2).
The SI derived unit of angular acceleration is the radian per second-squared.
See also
Angle, Time, AngularVelocity.
RadianPerSquareSecond, DegreePerSquareSecond.
https://en.wikipedia.org/wiki/Angular_acceleration
Examples
WorldBody.cpp.

◆ AngularMomentum

using playrho::AngularMomentum = typedef PLAYRHO_QUANTITY(boost::units::si::angular_momentum)

Angular momentum quantity.

This is the type alias for the angular momentum quantity. It's a derived quantity.

Note
This quantity's dimensions are: length-squared mass per time per angle (L^2 M T^-1 QP^-1).
The SI derived unit of angular momentum is the kilogram meter-squared per second.
See also
Length, Mass, Time, Angle, Momentum.
NewtonMeterSecond.
https://en.wikipedia.org/wiki/Angular_momentum
Examples
Joint.cpp, and RevoluteJoint.cpp.

◆ AngularVelocity

using playrho::AngularVelocity = typedef PLAYRHO_QUANTITY(boost::units::si::angular_velocity)

Angular velocity quantity.

This is the type alias for the plane angular velocity quantity. It's a derived quantity.

Note
This quantity's dimensions are: plane angle per time (QP T^-1).
The SI derived unit of angular velocity is the radian per second.
See also
Angle, Time.
RadianPerSecond, DegreePerSecond.
https://en.wikipedia.org/wiki/Angular_velocity
Examples
WorldBody.cpp.

◆ Area

using playrho::Area = typedef PLAYRHO_QUANTITY(boost::units::si::area)

Area quantity.

This is the type alias for the area quantity. It's a derived quantity.

Note
This quantity's dimension is: length squared (L^2).
The SI unit of area is the square-meter.
See also
Length.
SquareMeter.
https://en.wikipedia.org/wiki/Area

◆ AreaDensity

using playrho::AreaDensity = typedef PLAYRHO_QUANTITY(boost::units::si::surface_density)

Area (surface) density quantity.

This is the type alias for the area density quantity. It's a derived quantity.

Note
This quantity's dimensions are: mass per area (M L^-2).
The SI derived unit of area density is kilogram per meter-squared.
See also
Mass, Area.
KilogramPerSquareMeter.
https://en.wikipedia.org/wiki/Area_density

◆ Force

using playrho::Force = typedef PLAYRHO_QUANTITY(boost::units::si::force)

Force quantity.

This is the type alias for the force quantity. It's a derived quantity.

Note
This quantity's dimensions are: length mass per time squared (L M T^-2).
The SI derived unit of force is the newton.
See also
Length, Mass, Time.
Newton.
https://en.wikipedia.org/wiki/Force
Examples
TargetJoint.cpp.

◆ Frequency

using playrho::Frequency = typedef PLAYRHO_QUANTITY(boost::units::si::frequency)

Frequency quantity.

This is the type alias for the frequency quantity. It's a derived quantity that's the inverse of time.

Note
This quantity's dimension is: inverse time (T^-1).
The SI unit of frequency is the hertz.
See also
Time.
Hertz.
https://en.wikipedia.org/wiki/Frequency

◆ InvMass

using playrho::InvMass = typedef PLAYRHO_QUANTITY(playrho::units::si::inverse_mass)

Inverse mass quantity.

This is the type alias for the inverse mass quantity. It's a derived quantity that's the inverse of mass.

Note
This quantity's dimension is: inverse mass (M^-1).
See also
Mass.

◆ InvRotInertia

using playrho::InvRotInertia = typedef PLAYRHO_QUANTITY(playrho::units::si::inverse_moment_of_inertia)

Inverse rotational inertia quantity.

This is the type alias for the inverse rotational inertia quantity. It's a derived quantity.

Note
This quantity's dimensions are: angle-squared per length-squared per mass (L^-2 M^-1 QP^2).
See also
Length, Mass, Angle, RotInertia.
Examples
RevoluteJoint.cpp.

◆ Length

using playrho::Length = typedef PLAYRHO_QUANTITY(boost::units::si::length)

Length quantity.

This is the type alias for the length base quantity.

Note
This quantity's dimension is: length (L).
The SI unit of length is the meter.
See also
Meter.
https://en.wikipedia.org/wiki/Length
Examples
DistanceJoint.cpp, PrismaticJoint.cpp, and WheelJoint.cpp.

◆ LinearAcceleration

using playrho::LinearAcceleration = typedef PLAYRHO_QUANTITY(boost::units::si::acceleration)

Linear acceleration quantity.

This is the type alias for the linear acceleration derived quantity.

Note
This quantity's dimensions are: length over time squared (L T^-2).
The SI unit of linear acceleration is meters per second squared.
See also
Length, Time, LinearVelocity.
MeterPerSquareSecond.
https://en.wikipedia.org/wiki/Acceleration
Examples
WorldBody.cpp.

◆ LinearVelocity

using playrho::LinearVelocity = typedef PLAYRHO_QUANTITY(boost::units::si::velocity)

Linear velocity quantity.

This is the type alias for the linear velocity derived quantity.

Note
This quantity's dimensions are: length over time (L T^-1).
The SI unit of linear velocity is meters per second.
See also
Length, Time.
MeterPerSecond.
https://en.wikipedia.org/wiki/Speed
Examples
PrismaticJoint.cpp, and WorldBody.cpp.

◆ Mass

using playrho::Mass = typedef PLAYRHO_QUANTITY(boost::units::si::mass)

Mass quantity.

This is the type alias for the mass base quantity.

Note
This quantity's dimension is: mass (M).
The SI unit of mass is the kilogram.
See also
Kilogram.
https://en.wikipedia.org/wiki/Mass

◆ Momentum

using playrho::Momentum = typedef PLAYRHO_QUANTITY(boost::units::si::momentum)

Momentum quantity.

This is the type alias for the momentum quantity. It's a derived quantity.

Note
This quantity's dimensions are: length mass per time (L M T^-1).
The SI derived unit of momentum is the kilogram meter per second.
If p is momentum, m is mass, and v is velocity, then p = m * v.
See also
Length, Mass, Time.
NewtonSecond.
https://en.wikipedia.org/wiki/Momentum
Examples
PrismaticJoint.cpp.

◆ RotInertia

using playrho::RotInertia = typedef PLAYRHO_QUANTITY(boost::units::si::moment_of_inertia)

Rotational inertia quantity.

This is the type alias for the rotational inertia quantity. It's a derived quantity that's also called the moment of inertia or angular mass.

Note
This quantity's dimensions are: length-squared mass per angle-squared (L^2 M QP^-2).
The SI derived unit of rotational inertia is the kilogram meter-squared (kg * m^2).
See also
Length, Mass, Angle, InvRotInertia.
https://en.wikipedia.org/wiki/Moment_of_inertia
Examples
WheelJoint.cpp.

◆ SecondMomentOfArea

using playrho::SecondMomentOfArea = typedef PLAYRHO_QUANTITY(playrho::units::si::second_moment_of_area)

Second moment of area quantity.

This is the type alias for the second moment of area quantity. It's a derived quantity.

Note
This quantity's dimensions are: length-squared-squared (L^4).
See also
Length.
https://en.wikipedia.org/wiki/Second_moment_of_area

◆ Time

using playrho::Time = typedef PLAYRHO_QUANTITY(boost::units::si::time)

Time quantity.

This is the type alias for the time base quantity.

Note
This quantity's dimension is: time (T).
The SI unit of time is the second.
See also
Second.
https://en.wikipedia.org/wiki/Time_in_physics

◆ Torque

using playrho::Torque = typedef PLAYRHO_QUANTITY(boost::units::si::torque)

Torque quantity.

This is the type alias for the torque quantity. It's a derived quantity that's a rotational force.

Note
This quantity's dimensions are: length-squared mass per time-squared per angle (L^2 M T^-2 QP^-1).
The SI derived unit of torque is the newton meter.
See also
Length, Mass, Time, Angle.
NewtonMeter.
https://en.wikipedia.org/wiki/Torque