Click or drag to resize
DigitalRuneDirectionDistribution Class
A distribution that returns a random direction vector.
Inheritance Hierarchy
SystemObject
  DigitalRune.Mathematics.StatisticsDistributionVector3F
    DigitalRune.Mathematics.StatisticsDirectionDistribution

Namespace: DigitalRune.Mathematics.Statistics
Assembly: DigitalRune.Mathematics (in DigitalRune.Mathematics.dll) Version: 1.14.0.0 (1.14.0.14427)
Syntax
public class DirectionDistribution : Distribution<Vector3F>

The DirectionDistribution type exposes the following members.

Constructors
  NameDescription
Public methodDirectionDistribution
Initializes a new instance of the DirectionDistribution class
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNext
Gets a new random value for the underlying probability distribution.
(Overrides DistributionTNext(Random).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyDeviation
Gets or sets the angle of the cone measured from the central vector to a border vector.
Public propertyDirection
Gets or sets the direction of the cone (the central vector in the cone).
Public propertyIsUniform
Gets or sets a value indicating whether the random direction vectors are distributed uniformly or follow a Gaussian distribution
Public propertyNextValue Obsolete.
Gets a new random value for the underlying probability distribution.
(Inherited from DistributionT.)
Public propertyRandom Obsolete.
Gets or sets the random number generator.
(Inherited from DistributionT.)
Top
Remarks

Direction defines the main direction. Next(Random) returns a random direction vector that randomly deviates from Direction. The deviation can be uniformly distributed or follow an approximated Gaussian distribution (similar to FastGaussianDistributionF); see IsUniform. If the distribution is uniform (IsUniform is , default), Deviation defines the maximal deviation angle in radians. If the distribution is Gaussian (IsUniform is ), Deviation defines the standard deviation angle in radians.

See Also