CrystalSpace

Public API Reference

iBlob Struct Reference

A blob. More...

#include <ivaria/blobs.h>

Inheritance diagram for iBlob:

List of all members.

Public Member Functions

virtual void AddAnimationImage (const char *animname, const char *image)=0
 Add an animation image to a specific animation.
virtual void AddImage (const char *tag, const char *name, size_t index=100000, int offsetx=0, int offsety=0, int w=0, int h=0)=0
 When a blob is created it automatically gets an image with the tag '__main__'.
virtual void AnimateAlpha (float destalpha, csTicks ticks)=0
 Animate alpha over time.
virtual csTicks PlayAnimation (const char *animname, bool loop, bool remain=false, csTicks delay=200)=0
 Play an animation.
virtual void RemoveSecondaryImages ()=0
 Remove all secondary images (all images with tag different from '__main__'.
virtual void SetAlpha (float alpha)=0
 Set alpha to a specific value.
virtual void SetHorizontalSwap (bool sw, const char *tag)=0
 Set a horizontal swap for one of the images.
virtual void SetModifier (iImageModifier *modifier)=0
 Set a modifier on this blob.
virtual void StopAnimations ()=0
 Stop all animations.

Detailed Description

A blob.

This is a moving object representing an image.

Definition at line 156 of file blobs.h.


Member Function Documentation

virtual void iBlob::AddAnimationImage ( const char *  animname,
const char *  image 
) [pure virtual]

Add an animation image to a specific animation.

virtual void iBlob::AddImage ( const char *  tag,
const char *  name,
size_t  index = 100000,
int  offsetx = 0,
int  offsety = 0,
int  w = 0,
int  h = 0 
) [pure virtual]

When a blob is created it automatically gets an image with the tag '__main__'.

Using AddImage() one can create additional images that are layered on top of the first one.

virtual void iBlob::AnimateAlpha ( float  destalpha,
csTicks  ticks 
) [pure virtual]

Animate alpha over time.

virtual csTicks iBlob::PlayAnimation ( const char *  animname,
bool  loop,
bool  remain = false,
csTicks  delay = 200 
) [pure virtual]

Play an animation.

Basically this will replace the '__main__' image of this blob with the images specified by the animation. Only one animation can be active at the same time. If another animation is already running it will be stopped.

virtual void iBlob::RemoveSecondaryImages (  )  [pure virtual]

Remove all secondary images (all images with tag different from '__main__'.

virtual void iBlob::SetAlpha ( float  alpha  )  [pure virtual]

Set alpha to a specific value.

virtual void iBlob::SetHorizontalSwap ( bool  sw,
const char *  tag 
) [pure virtual]

Set a horizontal swap for one of the images.

virtual void iBlob::SetModifier ( iImageModifier modifier  )  [pure virtual]

Set a modifier on this blob.

virtual void iBlob::StopAnimations (  )  [pure virtual]

Stop all animations.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1