hou.Keyframe class

Class representing the default keyframe type, a numerical keyframe.

All Methods Replaces

Inheritence: hou.BaseKeyframe >

Methods

accel(self)double

Returns the acceleration leaving the keyframe.

This function raises hou.KeyframeValueNotSet if the acceleration has not been set.

evaluatedType(self)hou.parmData enum value

Not implemented yet

inAccel(self)double

Returns the acceleration entering the keyframe.

This method raises hou.KeyframeValueNotSet if the acceleration has not been set or it is tied.

inSlope(self)double

Returns the slope entering the keyframe.

This method raises hou.KeyframeValueNotSet if the slope has not been set or the slope is tied.

interpretAccelAsRatio(self, on)

Sets whether Houdini should interpret the acceleration values entering and leaving the keyframe as a single ratio. When set to True, the ratio of the in-acceleration to out-acceleration is always maintained. If, for example, the in-acceleration is made to be twice as large using the Channel Editor, then the out-acceleration will automatically be adjusted to be twice as large as well. This is the default behaviour for Houdini keyframes.

inValue(self)double

Returns the value entering the keyframe.

This method raises hou.KeyframeValueNotSet if the value has not been set or the value is tied.

isAccelInterpretedAsRatio(self)bool

Returns True if the acceleration values entering and leaving the keyframe are interpreted as a ratio by Houdini.

isAccelSet(self)bool

Returns True if the acceleration entering or leaving the keyframe has been set.

isAccelTied(self)bool

Returns True if the acceleration entering the keyframe has not been set.

isSlopeSet(self)bool

Returns True if the slope entering or leaving the keyframe has been set.

isSlopeTied(self)bool

Returns True if the slope entering the keyframe has not been set.

isValueSet(self)bool

Returns True if the value entering or leaving the keyframe has been set.

isValueTied(self)bool

Returns True if the value entering the keyframe has not been set.

setAccel(self, accel)

Sets the acceleration leaving the keyframe.

setInAccel(self, in_accel)

Sets the acceleration entering the keyframe. Sets the acceleration leaving the keyframe, if not already set. Unties the acceleration.

setInSlope(self, in_slope)

Sets the slope entering the keyframe. Sets the slope leaving the keyframe, if not already set. Unties the slope.

setInValue(self, in_value)

Sets the value entering the keyframe. Sets the value leaving the keyframe, if not already set. Unties the value.

setSlope(self, slope)

Sets the slope leaving the keyframe.

setValue(self, value)

Sets the value leaving the keyframe.

slope(self)double

Returns the slope leaving the keyframe.

This method raises hou.KeyframeValueNotSet if the slope has not been set.

unsetInAccel(self)

Unsets the acceleration entering the keyframe and untie the acceleration.

unsetInSlope(self)

Unsets the slope entering the keyframe and untie the slope.

unsetInValue(self)

Unsets the value entering the keyframe and untie the values.

value(self)double

Returns the value leaving the keyframe.

This method raises hou.KeyframeValueNotSet if the value has not been set.

Replaces

chkey command , chkeyls command