FCurve.HighClamp

Description

Sets or returns the higher-clamping value of the function curve as a Double. If the new clamp value out of range it is clamped within the valid range.

For fcurves connected to parameters the valid clamping range is determined by the Parameter.Min and Parameter.Max values.

For integer function curves the new highclamp value is rounded down. For example, a high clamp value of 4.5 becomes 4.0.

Examples

JScript Example

/*
        This example demonstrates how to get an FCurve's high clamping value.
*/
var oCube = ActiveSceneRoot.AddGeometry( "Cube","MeshSurface" );
var aValues = new Array( 0.00, 5.00, 1.00, 6.00, 2.00, 7.00, 3.00, 8.00, 4.00, 9.00, 5.00, 10.00 );
var oFCurve = oCube.PosX.AddFCurve2( aValues );
LogMessage( "FCurve high clamp : " + oFCurve.HighClamp );
// Outputs:
//INFO : FCurve high clamp : 1.7976931348623157e+308

See Also

FCurve.LowClamp Parameter.Min Parameter.Max