psEffectObjKeyFrameGroup Class Reference

Effect objects KeyFrame group. More...

#include <pseffectobj.h>

List of all members.

Public Member Functions
csPtr< psEffectObjKeyFrameGroup >	Clone () const
	Clones the key frame group object.
void	DeleteAll ()
	Deletes all of the keyframes in this group.
void	DeleteIndex (size_t idx)
	Deletes the keyframe at the given index.
psEffectObjKeyFrame *	Get (size_t idx) const
	Returns the keyframe at the given index.
size_t	GetSize () const
	Returns the number of keyframes in the group.
psEffectObjKeyFrame *	operator[] (size_t idx) const
	Returns the keyframe at the given index.
	psEffectObjKeyFrameGroup ()
void	Push (psEffectObjKeyFrame *keyFrame)
	Pushes a keyframe onto the group.
bool	SetFrameParamScalings (const float *scale)
	Adjust each parameter in each frame that have the use_scale property set with this scale.
	~psEffectObjKeyFrameGroup ()

---

Detailed Description

Effect objects KeyFrame group.

Definition at line 118 of file pseffectobj.h.

---

Constructor & Destructor Documentation

psEffectObjKeyFrameGroup::psEffectObjKeyFrameGroup

(

)

psEffectObjKeyFrameGroup::~psEffectObjKeyFrameGroup

(

)

---

Member Function Documentation

csPtr<psEffectObjKeyFrameGroup> psEffectObjKeyFrameGroup::Clone

(

)

const

Clones the key frame group object.

void psEffectObjKeyFrameGroup::DeleteAll

(

)

[inline]

Deletes all of the keyframes in this group.

Definition at line 182 of file pseffectobj.h.

void psEffectObjKeyFrameGroup::DeleteIndex

(

size_t

idx

)

[inline]

Deletes the keyframe at the given index.

Parameters:

idx	the index of the keyframe to delete

Definition at line 174 of file pseffectobj.h.

psEffectObjKeyFrame* psEffectObjKeyFrameGroup::Get

(

size_t

idx

)

const [inline]

Returns the keyframe at the given index.

Parameters:

idx	the index of the keyframe to grab

Returns:

the keyframe

Definition at line 143 of file pseffectobj.h.

size_t psEffectObjKeyFrameGroup::GetSize

(

)

const [inline]

Returns the number of keyframes in the group.

Returns:

the keyframe count

Definition at line 132 of file pseffectobj.h.

psEffectObjKeyFrame* psEffectObjKeyFrameGroup::operator[]

(

size_t

idx

)

const [inline]

Returns the keyframe at the given index.

Parameters:

idx	the index of the keyframe to grab

Returns:

the keyframe

Definition at line 154 of file pseffectobj.h.

void psEffectObjKeyFrameGroup::Push

(

psEffectObjKeyFrame *

keyFrame

)

[inline]

Pushes a keyframe onto the group.

Parameters:

keyFrame

the keyframe to push

Definition at line 164 of file pseffectobj.h.

bool psEffectObjKeyFrameGroup::SetFrameParamScalings

(

const float *

scale

)

Adjust each parameter in each frame that have the use_scale property set with this scale.

Returns:

True if if any params where scaled

---

The documentation for this class was generated from the following file:

• common/effects/pseffectobj.h