SIVector3.MinComponent

Description

Returns the minimum (signed) component value of this vector. Note that this is not the absolute minimum, but the signed minimum, so that a vector of x=10.0, y=-5.0, z=1.0 will return -5.0, not 1.0.

C# Syntax

Double SIVector3.MinComponent();

Scripting Syntax

oFloat = SIVector3.MinComponent();

Return Value

Floating point value (minimum signed component value of this vector).

Examples

JScript Example

// Create 3D vectors.
var v1 = XSIMath.CreateVector3( 10.0, -5.0, 1.0 );
// Note that this is actually a method, so it 
// takes the method syntax in JScript
var min = v1.MinComponent();
Application.LogMessage( min );
// Expected result
//INFO : -5

See Also

SIVector3.MinComponentIndex SIVector3.MaxComponent SIVector3.MaxComponentIndex SIVector3 SIMatrix3 SIMatrix4 SIRotation SITransformation SIQuaternion