CLerpNodePathInterval

class CLerpNodePathInterval

Bases: CLerpInterval

An interval that lerps one or more properties (like pos, hpr, etc.) on a NodePath over time.

Inheritance diagram

Inheritance diagram of CLerpNodePathInterval

explicit CLerpNodePathInterval(std::string const &name, double duration, CLerpInterval::BlendType blend_type, bool bake_in_start, bool fluid, NodePath const &node, NodePath const &other)
CLerpNodePathInterval(CLerpNodePathInterval const&) = default

Constructs a lerp interval that will lerp some properties on the indicated node, possibly relative to the indicated other node (if other is nonempty).

You must call set_end_pos(), etc. for the various properties you wish to lerp before the first call to priv_initialize(). If you want to set a starting value for any of the properties, you may call set_start_pos(), etc.; otherwise, the starting value is taken from the actual node’s value at the time the lerp is performed.

The starting values may be explicitly specified or omitted. The value of bake_in_start determines the behavior if the starting values are omitted. If bake_in_start is true, the values are obtained the first time the lerp runs, and thenceforth are stored within the interval. If bake_in_start is false, the starting value is computed each frame, based on assuming the current value represents the value set from the last time the interval was run. This “smart” behavior allows code to manipulate the object event while it is being lerped, and the lerp continues to apply in a sensible way.

If fluid is true, the prev_transform is not adjusted by the lerp; otherwise, it is reset.

static TypeHandle get_class_type(void)
NodePath const &get_node(void) const

Returns the node being lerped.

NodePath const &get_other(void) const

Returns the “other” node, which the lerped node is being moved relative to. If this is an empty node path, the lerped node is being moved in its own coordinate system.

int get_override(void) const

Returns the override value that will be associated with any state changes applied by the lerp. See set_override().

void set_end_color(LVecBase4 const &color)

Indicates that the color of the node should be lerped, and specifies the final color of the node. This should be called before priv_initialize(). If this is not called, the node’s color will not be affected by the lerp.

void set_end_color_scale(LVecBase4 const &color_scale)

Indicates that the color scale of the node should be lerped, and specifies the final color scale of the node. This should be called before priv_initialize(). If this is not called, the node’s color scale will not be affected by the lerp.

void set_end_hpr(LVecBase3 const &hpr)
void set_end_hpr(LQuaternion const &quat)

Indicates that the rotation of the node should be lerped, and specifies the final rotation of the node. This should be called before priv_initialize().

This replaces a previous call to set_end_quat(). If neither set_end_hpr() nor set_end_quat() is called, the node’s rotation will not be affected by the lerp.

Indicates that the rotation of the node should be lerped, and specifies the final rotation of the node. This should be called before priv_initialize().

This special function is overloaded to accept a quaternion, even though the function name is set_end_hpr(). The quaternion will be implicitly converted to a HPR trio, and the lerp will be performed in HPR space, componentwise.

void set_end_pos(LVecBase3 const &pos)

Indicates that the position of the node should be lerped, and specifies the final position of the node. This should be called before priv_initialize(). If this is not called, the node’s position will not be affected by the lerp.

void set_end_quat(LVecBase3 const &hpr)
void set_end_quat(LQuaternion const &quat)

Indicates that the rotation of the node should be lerped, and specifies the final rotation of the node. This should be called before priv_initialize().

This replaces a previous call to set_end_hpr(). If neither set_end_quat() nor set_end_hpr() is called, the node’s rotation will not be affected by the lerp.

This special function is overloaded to accept a HPR trio, even though the function name is set_end_quat(). The HPR will be implicitly converted to a quaternion, and the lerp will be performed in quaternion space, as a spherical lerp.

Indicates that the rotation of the node should be lerped, and specifies the final rotation of the node. This should be called before priv_initialize().

This replaces a previous call to set_end_hpr(). If neither set_end_quat() nor set_end_hpr() is called, the node’s rotation will not be affected by the lerp.

The given quaternion needs to be normalized.

void set_end_scale(LVecBase3 const &scale)
void set_end_scale(PN_stdfloat scale)

Indicates that the scale of the node should be lerped, and specifies the final scale of the node. This should be called before priv_initialize(). If this is not called, the node’s scale will not be affected by the lerp.

void set_end_shear(LVecBase3 const &shear)

Indicates that the shear of the node should be lerped, and specifies the final shear of the node. This should be called before priv_initialize(). If this is not called, the node’s shear will not be affected by the lerp.

void set_end_tex_offset(LVecBase2 const &tex_offset)

Indicates that the UV offset of the node should be lerped, and specifies the final UV offset of the node. This should be called before priv_initialize(). If this is not called, the node’s UV offset will not be affected by the lerp.

void set_end_tex_rotate(PN_stdfloat tex_rotate)

Indicates that the UV rotate of the node should be lerped, and specifies the final UV rotate of the node. This should be called before priv_initialize(). If this is not called, the node’s UV rotate will not be affected by the lerp.

void set_end_tex_scale(LVecBase2 const &tex_scale)

Indicates that the UV scale of the node should be lerped, and specifies the final UV scale of the node. This should be called before priv_initialize(). If this is not called, the node’s UV scale will not be affected by the lerp.

void set_override(int override)

Changes the override value that will be associated with any state changes applied by the lerp. If this lerp is changing state (for instance, a color lerp or a tex matrix lerp), then the new attributes created by this lerp will be assigned the indicated override value when they are applied to the node.

void set_start_color(LVecBase4 const &color)

Indicates the initial color of the lerped node. This is meaningful only if set_end_color() is also called. This parameter is optional; if unspecified, the value will be taken from the node’s actual color at the time the lerp is performed.

void set_start_color_scale(LVecBase4 const &color_scale)

Indicates the initial color scale of the lerped node. This is meaningful only if set_end_color_scale() is also called. This parameter is optional; if unspecified, the value will be taken from the node’s actual color scale at the time the lerp is performed.

void set_start_hpr(LVecBase3 const &hpr)

Indicates the initial rotation of the lerped node. This is meaningful only if either set_end_hpr() or set_end_quat() is also called. This parameter is optional; if unspecified, the value will be taken from the node’s actual rotation at the time the lerp is performed.

void set_start_pos(LVecBase3 const &pos)

Indicates the initial position of the lerped node. This is meaningful only if set_end_pos() is also called. This parameter is optional; if unspecified, the value will be taken from the node’s actual position at the time the lerp is performed.

void set_start_quat(LQuaternion const &quat)

Indicates the initial rotation of the lerped node. This is meaningful only if either set_end_quat() or set_end_hpr() is also called. This parameter is optional; if unspecified, the value will be taken from the node’s actual rotation at the time the lerp is performed.

The given quaternion needs to be normalized.

void set_start_scale(LVecBase3 const &scale)
void set_start_scale(PN_stdfloat scale)

Indicates the initial scale of the lerped node. This is meaningful only if set_end_scale() is also called. This parameter is optional; if unspecified, the value will be taken from the node’s actual scale at the time the lerp is performed.

void set_start_shear(LVecBase3 const &shear)

Indicates the initial shear of the lerped node. This is meaningful only if set_end_shear() is also called. This parameter is optional; if unspecified, the value will be taken from the node’s actual shear at the time the lerp is performed.

void set_start_tex_offset(LVecBase2 const &tex_offset)

Indicates the initial UV offset of the lerped node. This is meaningful only if set_end_tex_offset() is also called. This parameter is optional; if unspecified, the value will be taken from the node’s actual UV offset at the time the lerp is performed.

void set_start_tex_rotate(PN_stdfloat tex_rotate)

Indicates the initial UV rotate of the lerped node. This is meaningful only if set_end_tex_rotate() is also called. This parameter is optional; if unspecified, the value will be taken from the node’s actual UV rotate at the time the lerp is performed.

void set_start_tex_scale(LVecBase2 const &tex_scale)

Indicates the initial UV scale of the lerped node. This is meaningful only if set_end_tex_scale() is also called. This parameter is optional; if unspecified, the value will be taken from the node’s actual UV scale at the time the lerp is performed.

void set_texture_stage(TextureStage *stage)

Indicates the texture stage that is adjusted by tex_offset, tex_rotate, and/or tex_scale. If this is not set, the default is the default texture stage.