iPcSolid Struct Reference

A solid representation of an entity. More...

#include <propclass/solid.h>

Inheritance diagram for iPcSolid:

[legend]

List of all members.

Public Member Functions
virtual iCollider *	GetCollider ()=0
	Get (and create if needed) the collider for this mesh.
virtual iPcMesh *	GetMesh () const =0
	Get the current mesh on which we're working.
virtual void	SetMesh (iPcMesh *mesh)=0
	Set mesh from which to create the solid representation.
virtual void	Setup ()=0
	Force creation of the collider (equivalent to calling GetCollider() except that it forces a clean up of the previous collider).
virtual void	SetupBox (const csBox3 &box)=0
	Initialize a box collider (so ignore the mesh for collider).

---

Detailed Description

A solid representation of an entity.

This is used for collision detection.

This property class supports the following actions (add prefix 'cel.move.solid.action.' if you want to access this action through a message):

• Setup: no parameters. Call this after creation to actually setup the collider from the mesh that is attached so same entity.
• SetupBox: parameters 'min' (vector3) and 'max' (vector3). Setup a box collider (ignore attached mesh).

Definition at line 41 of file solid.h.

---

Member Function Documentation

virtual iCollider* iPcSolid::GetCollider

(

)

[pure virtual]

Get (and create if needed) the collider for this mesh.

If this returns 0 it means that the mesh object on which this property class is being used does not support collision detection.

virtual iPcMesh* iPcSolid::GetMesh

(

)

const [pure virtual]

Get the current mesh on which we're working.

virtual void iPcSolid::SetMesh

(

iPcMesh *

mesh

)

[pure virtual]

Set mesh from which to create the solid representation.

If not set a default mesh will be found from the parent entity.

virtual void iPcSolid::Setup

(

)

[pure virtual]

Force creation of the collider (equivalent to calling GetCollider() except that it forces a clean up of the previous collider).

virtual void iPcSolid::SetupBox

(

const csBox3 &

box

)

[pure virtual]

Initialize a box collider (so ignore the mesh for collider).

---

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

• propclass/solid.h