CrystalSpace

Public API Reference

iMovingObject Struct Reference

A moving object. More...

#include <ivaria/blobs.h>

Inheritance diagram for iMovingObject:

List of all members.

Public Member Functions

virtual void AddPathSegment (int x, int y, csTicks segmenttime)=0
 Add a path segment with a specific time for this segment.
virtual void Draw ()=0
 Draw the moving object.
virtual uint32 GetID () const =0
 Every moving object has a unique id.
virtual int GetLayer () const =0
 The layer of a moving object defines the priority for rendering.
virtual bool In (int x, int y)=0
 Test if a given coordinate is in the moving object.
virtual void Move (int x, int y)=0
 Move the moving object.
virtual void Scale (int w, int h)=0
 Scale the moving object.
virtual void SetClickable (bool click)=0
 FindMovingObject will only find objects if they are clickable.
virtual void SetLineMover (int x1, int y1, int x2, int y2, csTicks totaltime)=0
 Let the blob move along a specific line during the specified time.
virtual void SetPathMover (int start_x, int start_y)=0
 Let the blob move along a specific path.
virtual void SetViewPort (iBlobViewPort *viewport)=0
 The viewport on which this moving object moves.
virtual void Update (csTicks elapsed)=0
 Update the moving object based on time.

Detailed Description

A moving object.

Blobs and geoms can move and implement this interface.

Definition at line 59 of file blobs.h.


Member Function Documentation

virtual void iMovingObject::AddPathSegment ( int  x,
int  y,
csTicks  segmenttime 
) [pure virtual]

Add a path segment with a specific time for this segment.

virtual void iMovingObject::Draw (  )  [pure virtual]

Draw the moving object.

This is typically not called by the user.

virtual uint32 iMovingObject::GetID (  )  const [pure virtual]

Every moving object has a unique id.

virtual int iMovingObject::GetLayer (  )  const [pure virtual]

The layer of a moving object defines the priority for rendering.

Moving objects with a lower layer number will be rendered first. Other objects are rendered on top of them. Within a layer the render order is undefined.

virtual bool iMovingObject::In ( int  x,
int  y 
) [pure virtual]

Test if a given coordinate is in the moving object.

virtual void iMovingObject::Move ( int  x,
int  y 
) [pure virtual]

Move the moving object.

virtual void iMovingObject::Scale ( int  w,
int  h 
) [pure virtual]

Scale the moving object.

virtual void iMovingObject::SetClickable ( bool  click  )  [pure virtual]

FindMovingObject will only find objects if they are clickable.

virtual void iMovingObject::SetLineMover ( int  x1,
int  y1,
int  x2,
int  y2,
csTicks  totaltime 
) [pure virtual]

Let the blob move along a specific line during the specified time.

virtual void iMovingObject::SetPathMover ( int  start_x,
int  start_y 
) [pure virtual]

Let the blob move along a specific path.

With SetPathMover() you set the start location of the path. Use AddPathSegment() to add path segments then.

virtual void iMovingObject::SetViewPort ( iBlobViewPort viewport  )  [pure virtual]

The viewport on which this moving object moves.

virtual void iMovingObject::Update ( csTicks  elapsed  )  [pure virtual]

Update the moving object based on time.

This is typically not called by the user.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1