Statics Methods Relevant to NumberBvr Objects

abs Creates a number behavior that represents the absolute value of the given number behavior.

acos Creates a number behavior that represents the arccosine (inverse cosine) of the given behavior.

add Creates a number behavior representing the sum of the given number behaviors.

asin Creates a number behavior that represents the arcsine (inverse sine) of the given behavior.

atan Creates a number behavior that represents the arctangent (inverse tangent) of the given behavior.

atan2 Creates a number behavior that represents the arctangent (inverse tangent) of the quotient of the given behaviors.

bSpline Creates a NumberBvr behavior based on a B-spline function.

ceiling Creates a number behavior that represents the ceiling value, the smallest integer value that is greater than or equal to the value of the given behavior.

cos Creates a number behavior that represents the cosine of the given behavior.

degreesToRadians Creates a number behavior that represents the value of the given behavior converted from degrees to radians.

derivative Creates a number behavior of the instantaneous derivative (rate of change) of the given number behavior.

div Creates an number behavior representing the quotient of the given number behaviors.

eq Creates a Boolean behavior that represents the relation a = b.

exp Creates a number behavior that represents the exponential of the given behavior.

floor Creates a number behavior that represents the floor value, the largest integer value that is less than or equal to the value of the given behavior.

gt Creates a Boolean behavior that represents the relation a > b.

gte Creates a Boolean behavior that represents the relation a ³ b.

integral Creates a number behavior that represents the sum of all values of a from the start time to the present.

interpolate Creates a NumberBvr object that moves along the interval in duration seconds.

ln Creates a number behavior that represents the natural logarithm of the given behavior.

log10 Creates a number behavior that represents the common logarithm (base-10 logarithm) of the given behavior.

lt Creates a Boolean behavior that represents the relation a < b.

lte Creates a Boolean behavior that represents the relation a £ b.

mod Creates a number behavior that represents the modulus of the given behaviors.

mul Creates a number behavior representing the product of the given number behaviors.

ne Creates a BooleanBvr behavior that represents the relation a != b.

neg Creates a number behavior representing the negation of the given number behavior.

pow Creates a number behavior representing a raised to the power of b.

radiansToDegrees Creates a number behavior that represents the value of the given behavior converted from radians to degrees.

round Creates a number behavior that represents the value of the given behavior, rounded to the nearest integer.

seededRandom Creates a number behavior that represents an infinite, time-varying sequence of pseudo-random values.

sin Creates a number behavior that represents the sine of the given behavior.

slowInSlowOut Creates a NumberBvr object that moves along the interval in duration seconds.

sqrt Creates a number behavior that represents the square root of the given number behavior.

sub Creates a number behavior representing the difference of the given number behaviors.

tan Creates a number behavior that represents the tangent of the given behavior.

toBvr Converts a double floating-point number to a NumberBvr.

abs

Statics Class

Creates a number behavior that represents the absolute value of the given number behavior. The behavior's value is equal to the absolute value (the non-negative equivalent) of the value of a.

Syntax

public static NumberBvr abs( NumberBvr a );

Parameters

a
NumberBvr object to apply the operation to.

Return Value

Returns the NumberBvr object.

acos

Statics Class

Creates a number behavior that represents the arccosine (inverse cosine) of the given behavior.

Syntax

public static NumberBvr acos( NumberBvr a );

Parameters

a
NumberBvr object. The value of the behavior is assumed to be a cosine value.

Return Value

Returns the NumberBvr object.

See Also

asin

add

Statics Class

Creates a number behavior representing the sum of the given number behaviors. The behavior's value is the value of a added to the value of b (a + b).

Syntax

public static NumberBvr add( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to add.

Return Value

Returns the NumberBvrobject.

asin

Statics Class

Creates a number behavior that represents the arcsine (inverse sine) of the given behavior.

Syntax

public static NumberBvr asin( NumberBvr a );

Parameters

a
NumberBvr object. The value of the behavior is assumed to be a sine value.

Return Value

Returns the NumberBvr object.

See Also

acos

atan

Statics Class

Creates a number behavior that represents the arctangent (inverse tangent) of the given behavior.

Syntax

public static NumberBvr atan( NumberBvr a );

Parameters

a
NumberBvr object.

Return Value

Returns the NumberBvr object.

See Also

acos, asin, atan2

atan2

Statics Class

Creates a number behavior that represents the arctangent (inverse tangent) of the quotient of the given behaviors. The behavior's value is the inverse tangent of the value of a divided by the value of b.

Syntax

public static NumberBvr atan2( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to divide.

Return Value

Returns the NumberBvr object.

See Also

acos, asin

bSpline

Statics Class

Creates a NumberBvr behavior based on a B-spline function. The function depends on the control elements, the knot vector, the mathematical degree, and the weights of the control elements (these are optional).

Syntax

public static NumberBvr bSpline(
     int degree,
     NumberBvr[] knots,
     NumberBvr[] control_elements,
     NumberBvr[] weights,
     NumberBvr evaluation
);

Parameters

degree
Number representing the mathematical degree of the B-spline to evaluate. Must be 1, 2, or 3.
knots
Array of NumberBvr objects representing the knots used to calculate the B-spline.
control_elements
Array of NumberBvr objects representing the control elements used to calculate the B-spline.
weights
Array of NumberBvr objects representing the weights used to calculate the rational B-spline. There must be the same number of weights as control elements. For non-rational B-splines, the value of weights is null.
evaluation
NumberBvr object that controls the spline evaluation.

Return Value

Returns the NumberBvr object.

Remarks

A B-spline function without weights is piecewise polynomial and with weights is piecewise rational (the quotient of two polynomials). It requires that:
numberOfControlElements = numberOfKnots - degree + 1
The control elements define the approximate direction and shape of the function. The knots represent junction values, in parameter space, between the connected polynomial parts.
Given a degree d and a number of knots k, the function is valid in the range knotd to knotk-d+1, and is otherwise undefined. For example, for a degree 2 curve, the valid range is from the second knot to the next to the last knot, inclusive.
The returned NumberBvr is the traversal of the spline function according to the evaluation parameter. The evaluation parameter is a NumberBvr that must be in the valid range of the spline, which is [knotd, knotk-d+1]. Any values outside this range are automatically clamped to the end values.

ceiling

Statics Class

Creates a number behavior that represents the ceiling value, the smallest integer value that is greater than or equal to the value of the given behavior.

Syntax

public static NumberBvr ceiling( NumberBvr a );

Parameters

a
NumberBvr object to find the ceiling for.

Return Value

Returns the NumberBvr object.

cos

Statics Class

Creates a number behavior that represents the cosine of the given behavior.

Syntax

public static NumberBvr cos( NumberBvr a );

Parameters

a
NumberBvr object. The value of the behavior is assumed to be in radians.

Return Value

Returns the NumberBvr object.

See Also

sin

degreesToRadians

Statics Class

Creates a number behavior that represents the value of the given behavior converted from degrees to radians.

Syntax

public static NumberBvr degreesToRadians( NumberBvr a );

Parameters

a
NumberBvr object to convert.

Return Value

Returns the NumberBvr object.

derivative

Statics Class

Creates a number behavior of the instantaneous derivative (rate of change) of the given number behavior. For example, a constant number yields a constant derivative of 0 and a value equal to "time" yields a constant derivative of 1.

Syntax

public static NumberBvr derivative( NumberBvr a );

Parameters

a
NumberBvr object for which to calculate the derivative.

Return Value

Returns the NumberBvr object.

div

Statics Class

Creates an number behavior representing the quotient of the given number behaviors. The behavior's value is the value of a divided by the value of b (a/b).

Syntax

public static NumberBvr div( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to divide.

Return Value

Returns NumberBvr the object.

eq

Statics Class

Creates a boolean behavior that represents the relation a = b. The behavior's value is true when the value of a is equal to the value of b, otherwise, it is false.

Syntax

public static BooleanBvr eq( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to compare.

Return Value

Returns the BooleanBvr object.

exp

Statics Class

Creates a number behavior that represents the exponential of the given behavior. The behavior's value is the base of natural logarithms, e, raised to the power of the value of a.

Syntax

public static NumberBvr exp( NumberBvr a );

Parameters

a
NumberBvr object to apply as an exponent of e.

Return Value

Returns the NumberBvr object.

See Also

ln

floor

Statics Class

Creates a number behavior that represents the floor value, the largest integer value that is less than or equal to the value of the given behavior.

Syntax

public static NumberBvr floor( NumberBvr a );

Parameters

a
NumberBvr object to find the floor for.

Return Value

Returns the NumberBvr object.

gt

Statics Class

Creates a boolean behavior that represents the relation a > b. The behavior's value is true when the value of a is greater than the value of b, otherwise, it is false.

Syntax

public static BooleanBvr gt( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to compare.

Return Value

Returns the BooleanBvr object.

gte

Statics Class

Creates a boolean behavior that represents the relation a ≥ b. The behavior's value is true when the value of a is greater than or equal to the value of b, otherwise, it is false.

Syntax

public static BooleanBvr gte( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to compare.

Return Value

Returns the BooleanBvr object.

integral

Statics Class

Creates a number behavior that represents the sum of all values of a from the start time to the present.

Syntax

public static NumberBvr integral( NumberBvr a );

Parameters

a
NumberBvr object to integrate.

Return Value

Returns the NumberBvr object.

interpolate

Statics Class

Creates a NumberBvr object that moves along the interval in duration seconds. Velocity is constant.

Syntax

public static NumberBvr interpolate(
NumberBvr from, NumberBvr to, NumberBvr duration );

Parameters

from
Beginning NumberBvr object. This parameter can also be of type double.
to
Ending NumberBvr object. This parameter can also be of type double.
duration
NumberBvr object representing the length of time, in seconds. This parameter can also be of type double.

Return Value

Returns the NumberBvr object.

ln

Statics Class

Creates a number behavior that represents the natural logarithm of the given behavior. The behavior's value is the value by which the base of natural logarithms, e, must be raised to equal the value of a.

Syntax

public static NumberBvr ln( NumberBvr a );

Parameters

a
NumberBvr object for which to calculate the natural logarithm.

Return Value

Returns the NumberBvr object.

See Also

exp

log10

Statics Class

Creates a number behavior that represents the common logarithm (base-10 logarithm) of the given behavior. The behavior's value is the value by which 10 must be raised to equal the value of a.

Syntax

public static NumberBvr log10( NumberBvr a );

Parameters

a
NumberBvr object for which to calculate the common logarithm.

Return Value

Returns the NumberBvr object.

lt

Statics Class

Creates a Boolean behavior that represents the relation a < b. The behavior's value is true when the value of a is less than the value of b, otherwise, it is false.

Syntax

public static BooleanBvr lt( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to compare.

Return Value

Returns the BooleanBvr object.

lte

Statics Class

Creates a Boolean behavior that represents the relation a ≤ b. The behavior's value is true when the value of a is less than or equal to the value of b, otherwise, it is false.

Syntax

public static BooleanBvr lte( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to compare.

Return Value

Returns the BooleanBvr object.

mod

Statics Class

Creates a number behavior that represents the modulus of the given behaviors. The behavior's value is the modulus, the remainder of the floating-point value of a divided by the floating-point value of b.

Syntax

public static NumberBvr mod( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to calculate the modulus for.

Return Value

Returns the NumberBvr object.

Remarks

If a=7.6 and b=3.1, then mod(a,b)= 2.4, since 3.1 will go into 7.6 evenly two times, with a remainder of 2.4.

mul

Statics Class

Creates a number behavior representing the product of the given number behaviors. The behavior's value is the value of a multiplied by the value of b (a ´ b).

Syntax

public static NumberBvr mul( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to multiply.

Return Value

Returns the NumberBvr object.

ne

Statics Class

Creates a BooleanBvr behavior that represents the relation a != b. The behavior's value is true when the value of a is not equal to the value of b, otherwise, it is false.

Syntax

public static BooleanBvr ne( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to compare.

Return Value

Returns the BooleanBvr object.

neg

Statics Class

Creates a number behavior representing the negation of the given number behavior. The behavior's value is equal to the value of a subtracted from zero (0 - a).

Syntax

public static NumberBvr neg( NumberBvr a );

Parameters

a
NumberBvr object to negate.

Return Value

Returns the NumberBvr object.

pow

Statics Class

Creates a number behavior representing a raised to the power of b. The behavior's value is equal to a^b.

Syntax

public static NumberBvr pow( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to apply the operation to.

Return Value

Returns the NumberBvr object.

radiansToDegrees

Statics Class

Creates a number behavior that represents the value of the given behavior converted from radians to degrees.

Syntax

public static NumberBvr radiansToDegrees( NumberBvr a );

Parameters

a
NumberBvr object to convert.

Return Value

Returns the NumberBvr object.

round

Statics Class

Creates a number behavior that represents the value of the given behavior, rounded to the nearest integer.

Syntax

public static NumberBvr round( NumberBvr a );

Parameters

a
NumberBvr object to be rounded.

seededRandom

Statics Class

Creates a number behavior that represents an infinite, time-varying sequence of pseudo-random values.

Syntax

public static NumberBvr seededRandom( double seed );

Parameters

seed
The double value that provides the seed, or starting value, for the sequence.

Return Value

Returns the NumberBvr object.

sin

Statics Class

Creates a number behavior that represents the sine of the given behavior.

Syntax

public static NumberBvr sin( NumberBvr a );

Parameters

a
NumberBvr object. The value of the behavior is assumed to be in radians.

Return Value

Returns the NumberBvr object.

See Also

cos

slowInSlowOut

Statics Class

Creates a NumberBvr object that moves along the interval in duration seconds. The animation is dampened so that the number increases slowly, hits a maximum speed at the midpoint, and then decelerates until the end is reached. The acceleration is specified in Gs, or multiples of the earth's gravitational constant.

Syntax

public static NumberBvr slowInSlowOut(
     NumberBvr from,
     NumberBvr to,
     NumberBvr duration,
     NumberBvr acceleration
);

Parameters

from
NumberBvr object that is the beginning of the animation. This parameter can also be of type double.
to
NumberBvr object that is the end of the animation. This parameter can also be of type double.
duration
NumberBvr object that is the length of the animation, in seconds. This parameter can also be of type double.
acceleration
NumberBvr object that is the rate of acceleration, in Gs. This parameter can also be of type double.

Return Value

Returns the NumberBvr object.

sqrt

Statics Class

Creates a number behavior that represents the square root of the given number behavior. The behavior's value is the square root of the value of a.

Syntax

public static NumberBvr sqrt( NumberBvr a );

Parameters

a
NumberBvr object to apply the square root operation to.

Return Value

Returns the NumberBvr object.

sub

Statics Class

Creates a number behavior representing the difference of the given number behaviors. The behavior's value is the value of b subtracted from a (a - b).

Syntax

public static NumberBvr sub( NumberBvr a, NumberBvr b );

Parameters

a and b
NumberBvr objects to subtract.

Return Value

Returns the NumberBvr object.

tan

Statics Class

Creates a number behavior that represents the tangent of the given behavior.

Syntax

public static NumberBvr tan( NumberBvr a );

Parameters

a
NumberBvr object. The value of the behavior is assumed to be in radians.

Return Value

Returns the NumberBvr object.

See Also

atan, cos, sin

toBvr

Statics Class

Converts a double floating-point number to a NumberBvr. The only time toBvr is used is when converting Java numbers, Booleans, or strings to their corresponding Microsoft® DirectAnimation® types. It is not used for constants such as red, yVector3, and origin2 because these are defined as constant behaviors.

Syntax

public static NumberBvr toBvr( double a );

Parameters

a
The double floating-point number to be converted.

Return Value

Returns the NumberBvr object.