Obstacle Class Reference

A Modifier that acts as an obstacle on particles. More...

Inheritance diagram for Obstacle:

List of all members.

Public Member Functions
	Obstacle (Zone *zone=NULL, ModifierTrigger trigger=INTERSECT_ZONE, float bouncingRatio=1.0f, float friction=1.0f)
	Constructor of Obstacle.
void	setBouncingRatio (float bouncingRatio)
	Sets the bouncing ratio of this Obstacle.
void	setFriction (float friction)
	Sets the friction of this Obstacle.
float	getBouncingRatio () const
	Gets the bouncing ratio of this Obstacle.
float	getFriction () const
	Gets the friction of this Obstacle.
Static Public Member Functions
static Obstacle *	create (Zone *zone=NULL, ModifierTrigger trigger=INTERSECT_ZONE, float bouncingRatio=1.0f, float friction=1.0f)
	Creates and registers a new Obstacle.

---

Detailed Description

A Modifier that acts as an obstacle on particles.

Definition at line 36 of file SPK_Obstacle.h.

---

Constructor & Destructor Documentation

Obstacle	(	Zone *	zone = NULL,
		ModifierTrigger	trigger = INTERSECT_ZONE,
		float	bouncingRatio = 1.0f,
		float	friction = 1.0f
	)

Constructor of Obstacle.

Parameters:

	zone	: the Zone of the Obstacle
	trigger	: the trigger of the Destructor
	bouncingRatio	: the bouncingRatio of the Obstacle
	friction	: the friction of the Obstacle

---

Member Function Documentation

Obstacle * create	(	Zone *	zone = NULL,
		ModifierTrigger	trigger = INTERSECT_ZONE,
		float	bouncingRatio = 1.0f,
		float	friction = 1.0f
	)			[static]

Creates and registers a new Obstacle.

Parameters:

	zone	: the Zone of the Obstacle
	trigger	: the trigger of the Destructor
	bouncingRatio	: the bouncingRatio of the Obstacle
	friction	: the friction of the Obstacle

Returns:

A new registered Obstacle

Since:

1.04.00

Definition at line 114 of file SPK_Obstacle.h.

float getBouncingRatio

(

)

const

Gets the bouncing ratio of this Obstacle.

Returns:

the bouncing ratio of this Obstacle

Definition at line 131 of file SPK_Obstacle.h.

float getFriction

(

)

const

Gets the friction of this Obstacle.

Returns:

the friction of this Obstacle

Definition at line 136 of file SPK_Obstacle.h.

void setBouncingRatio

(

float

bouncingRatio

)

Sets the bouncing ratio of this Obstacle.

The bouncing ratio is the multiplier applied to the normal component of the rebound.

Parameters:

bouncingRatio

: the bouncing ratio of this Obstacle

Definition at line 121 of file SPK_Obstacle.h.

void setFriction

(

float

friction

)

Sets the friction of this Obstacle.

The bouncing ratio is the multiplier applied to the tangent component of the rebound.

Parameters:

friction

: the friction of this Obstacle

Definition at line 126 of file SPK_Obstacle.h.