idLight Class Reference

#include <Light.h>

Inheritance diagram for idLight:

Public Types
enum	{ EVENT_BECOMEBROKEN = idEntity::EVENT_MAXEVENTS, EVENT_MAXEVENTS }
Public Types inherited from idEntity
enum	{ EVENT_STARTSOUNDSHADER, EVENT_STOPSOUNDSHADER, EVENT_MAXEVENTS }

Public Member Functions
	CLASS_PROTOTYPE (idLight)
	idLight ()
	~idLight ()
void	Spawn (void)
void	Save (idSaveGame *savefile) const
void	Restore (idRestoreGame *savefile)
virtual void	UpdateChangeableSpawnArgs (const idDict *source)
virtual void	Think (void)
virtual void	FreeLightDef (void)
virtual bool	GetPhysicsToSoundTransform (idVec3 &origin, idMat3 &axis)
void	Present (void)
void	SaveState (idDict *args)
virtual void	SetColor (float red, float green, float blue)
virtual void	SetColor (const idVec4 &color)
virtual void	GetColor (idVec3 &out) const
virtual void	GetColor (idVec4 &out) const
const idVec3 &	GetBaseColor (void) const
void	SetShader (const char *shadername)
void	SetLightParm (int parmnum, float value)
void	SetLightParms (float parm0, float parm1, float parm2, float parm3)
void	SetRadiusXYZ (float x, float y, float z)
void	SetRadius (float radius)
void	On (void)
void	Off (void)
void	Fade (const idVec4 &to, float fadeTime)
void	FadeOut (float time)
void	FadeIn (float time)
void	Killed (idEntity *inflictor, idEntity *attacker, int damage, const idVec3 &dir, int location)
void	BecomeBroken (idEntity *activator)
qhandle_t	GetLightDefHandle (void) const
void	SetLightParent (idEntity *lparent)
void	SetLightLevel (void)
virtual void	ShowEditingDialog (void)
virtual void	ClientPredictionThink (void)
virtual void	WriteToSnapshot (idBitMsgDelta &msg) const
virtual void	ReadFromSnapshot (const idBitMsgDelta &msg)
virtual bool	ClientReceiveEvent (int event, int time, const idBitMsg &msg)
Public Member Functions inherited from idEntity
	ABSTRACT_PROTOTYPE (idEntity)
	idEntity ()
	~idEntity ()
void	Spawn (void)
void	Save (idSaveGame *savefile) const
void	Restore (idRestoreGame *savefile)
const char *	GetEntityDefName (void) const
void	SetName (const char *name)
const char *	GetName (void) const
virtual renderView_t *	GetRenderView ()
bool	CheckDormant (void)
virtual void	DormantBegin (void)
virtual void	DormantEnd (void)
bool	IsActive (void) const
void	BecomeActive (int flags)
void	BecomeInactive (int flags)
void	UpdatePVSAreas (const idVec3 &pos)
virtual renderEntity_t *	GetRenderEntity (void)
virtual int	GetModelDefHandle (void)
virtual void	SetModel (const char *modelname)
void	SetSkin (const idDeclSkin *skin)
const idDeclSkin *	GetSkin (void) const
void	SetShaderParm (int parmnum, float value)
virtual void	SetColor (const idVec3 &color)
virtual void	FreeModelDef (void)
virtual void	Hide (void)
virtual void	Show (void)
bool	IsHidden (void) const
void	UpdateVisuals (void)
void	UpdateModel (void)
void	UpdateModelTransform (void)
virtual void	ProjectOverlay (const idVec3 &origin, const idVec3 &dir, float size, const char *material)
int	GetNumPVSAreas (void)
const int *	GetPVSAreas (void)
void	ClearPVSAreas (void)
bool	PhysicsTeamInPVS (pvsHandle_t pvsHandle)
virtual bool	UpdateAnimationControllers (void)
bool	UpdateRenderEntity (renderEntity_s *renderEntity, const renderView_t *renderView)
virtual idAnimator *	GetAnimator (void)
virtual bool	CanPlayChatterSounds (void) const
bool	StartSound (const char *soundName, const s_channelType channel, int soundShaderFlags, bool broadcast, int *length)
bool	StartSoundShader (const idSoundShader *shader, const s_channelType channel, int soundShaderFlags, bool broadcast, int *length)
void	StopSound (const s_channelType channel, bool broadcast)
void	SetSoundVolume (float volume)
void	UpdateSound (void)
int	GetListenerId (void) const
idSoundEmitter *	GetSoundEmitter (void) const
void	FreeSoundEmitter (bool immediate)
virtual void	PreBind (void)
virtual void	PostBind (void)
virtual void	PreUnbind (void)
virtual void	PostUnbind (void)
void	JoinTeam (idEntity *teammember)
void	Bind (idEntity *master, bool orientated)
void	BindToJoint (idEntity *master, const char *jointname, bool orientated)
void	BindToJoint (idEntity *master, jointHandle_t jointnum, bool orientated)
void	BindToBody (idEntity *master, int bodyId, bool orientated)
void	Unbind (void)
bool	IsBound (void) const
bool	IsBoundTo (idEntity *master) const
idEntity *	GetBindMaster (void) const
jointHandle_t	GetBindJoint (void) const
int	GetBindBody (void) const
idEntity *	GetTeamMaster (void) const
idEntity *	GetNextTeamEntity (void) const
void	ConvertLocalToWorldTransform (idVec3 &offset, idMat3 &axis)
idVec3	GetLocalVector (const idVec3 &vec) const
idVec3	GetLocalCoordinates (const idVec3 &vec) const
idVec3	GetWorldVector (const idVec3 &vec) const
idVec3	GetWorldCoordinates (const idVec3 &vec) const
bool	GetMasterPosition (idVec3 &masterOrigin, idMat3 &masterAxis) const
void	GetWorldVelocities (idVec3 &linearVelocity, idVec3 &angularVelocity) const
void	SetPhysics (idPhysics *phys)
idPhysics *	GetPhysics (void) const
void	RestorePhysics (idPhysics *phys)
bool	RunPhysics (void)
void	SetOrigin (const idVec3 &org)
void	SetAxis (const idMat3 &axis)
void	SetAngles (const idAngles &ang)
bool	GetFloorPos (float max_dist, idVec3 &floorpos) const
virtual bool	GetPhysicsToVisualTransform (idVec3 &origin, idMat3 &axis)
virtual bool	Collide (const trace_t &collision, const idVec3 &velocity)
virtual void	GetImpactInfo (idEntity *ent, int id, const idVec3 &point, impactInfo_t *info)
virtual void	ApplyImpulse (idEntity *ent, int id, const idVec3 &point, const idVec3 &impulse)
virtual void	AddForce (idEntity *ent, int id, const idVec3 &point, const idVec3 &force)
virtual void	ActivatePhysics (idEntity *ent)
virtual bool	IsAtRest (void) const
virtual int	GetRestStartTime (void) const
virtual void	AddContactEntity (idEntity *ent)
virtual void	RemoveContactEntity (idEntity *ent)
virtual bool	CanDamage (const idVec3 &origin, idVec3 &damagePoint) const
virtual void	Damage (idEntity *inflictor, idEntity *attacker, const idVec3 &dir, const char *damageDefName, const float damageScale, const int location)
virtual void	AddDamageEffect (const trace_t &collision, const idVec3 &velocity, const char *damageDefName)
virtual void	DamageFeedback (idEntity *victim, idEntity *inflictor, int &damage)
virtual bool	Pain (idEntity *inflictor, idEntity *attacker, int damage, const idVec3 &dir, int location)
virtual bool	ShouldConstructScriptObjectAtSpawn (void) const
virtual idThread *	ConstructScriptObject (void)
virtual void	DeconstructScriptObject (void)
void	SetSignal (signalNum_t signalnum, idThread *thread, const function_t *function)
void	ClearSignal (idThread *thread, signalNum_t signalnum)
void	ClearSignalThread (signalNum_t signalnum, idThread *thread)
bool	HasSignal (signalNum_t signalnum) const
void	Signal (signalNum_t signalnum)
void	SignalEvent (idThread *thread, signalNum_t signalnum)
void	TriggerGuis (void)
bool	HandleGuiCommands (idEntity *entityGui, const char *cmds)
virtual bool	HandleSingleGuiCommand (idEntity *entityGui, idLexer *src)
void	FindTargets (void)
void	RemoveNullTargets (void)
void	ActivateTargets (idEntity *activator) const
virtual void	Teleport (const idVec3 &origin, const idAngles &angles, idEntity *destination)
bool	TouchTriggers (void) const
idCurve_Spline< idVec3 > *	GetSpline (void) const
virtual bool	ServerReceiveEvent (int event, int time, const idBitMsg &msg)
void	WriteBindToSnapshot (idBitMsgDelta &msg) const
void	ReadBindFromSnapshot (const idBitMsgDelta &msg)
void	WriteColorToSnapshot (idBitMsgDelta &msg) const
void	ReadColorFromSnapshot (const idBitMsgDelta &msg)
void	WriteGUIToSnapshot (idBitMsgDelta &msg) const
void	ReadGUIFromSnapshot (const idBitMsgDelta &msg)
void	ServerSendEvent (int eventId, const idBitMsg *msg, bool saveEvent, int excludeClient) const
void	ClientSendEvent (int eventId, const idBitMsg *msg) const
Public Member Functions inherited from idClass
	ABSTRACT_PROTOTYPE (idClass)
void *	operator new (size_t)
void *	operator new (size_t s, int, int, char *, int)
void	operator delete (void *)
void	operator delete (void *, int, int, char *, int)
virtual	~idClass ()
void	Spawn (void)
void	CallSpawn (void)
bool	IsType (const idTypeInfo &c) const
const char *	GetClassname (void) const
const char *	GetSuperclass (void) const
void	FindUninitializedMemory (void)
void	Save (idSaveGame *savefile) const
void	Restore (idRestoreGame *savefile)
bool	RespondsTo (const idEventDef &ev) const
bool	PostEventMS (const idEventDef *ev, int time)
bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1)
bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2)
bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3)
bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4)
bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5)
bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6)
bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7)
bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7, idEventArg arg8)
bool	PostEventSec (const idEventDef *ev, float time)
bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1)
bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2)
bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3)
bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4)
bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5)
bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6)
bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7)
bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7, idEventArg arg8)
bool	ProcessEvent (const idEventDef *ev)
bool	ProcessEvent (const idEventDef *ev, idEventArg arg1)
bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2)
bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3)
bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4)
bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5)
bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6)
bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7)
bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7, idEventArg arg8)
bool	ProcessEventArgPtr (const idEventDef *ev, int *data)
void	CancelEvents (const idEventDef *ev)
void	Event_Remove (void)

Private Member Functions
void	PresentLightDefChange (void)
void	PresentModelDefChange (void)
void	Event_SetShader (const char *shadername)
void	Event_GetLightParm (int parmnum)
void	Event_SetLightParm (int parmnum, float value)
void	Event_SetLightParms (float parm0, float parm1, float parm2, float parm3)
void	Event_SetRadiusXYZ (float x, float y, float z)
void	Event_SetRadius (float radius)
void	Event_Hide (void)
void	Event_Show (void)
void	Event_On (void)
void	Event_Off (void)
void	Event_ToggleOnOff (idEntity *activator)
void	Event_SetSoundHandles (void)
void	Event_FadeOut (float time)
void	Event_FadeIn (float time)

Private Attributes
renderLight_t	renderLight
idVec3	localLightOrigin
idMat3	localLightAxis
qhandle_t	lightDefHandle
idStr	brokenModel
int	levels
int	currentLevel
idVec3	baseColor
bool	breakOnTrigger
int	count
int	triggercount
idEntity *	lightParent
idVec4	fadeFrom
idVec4	fadeTo
int	fadeStart
int	fadeEnd
bool	soundWasPlaying

Additional Inherited Members
Static Public Member Functions inherited from idEntity
static bool	ModelCallback (renderEntity_s *renderEntity, const renderView_t *renderView)
Static Public Member Functions inherited from idClass
static void	Init (void)
static void	Shutdown (void)
static idTypeInfo *	GetClass (const char *name)
static void	DisplayInfo_f (const idCmdArgs &args)
static void	ListClasses_f (const idCmdArgs &args)
static idClass *	CreateInstance (const char *name)
static int	GetNumTypes (void)
static int	GetTypeNumBits (void)
static idTypeInfo *	GetType (int num)
Public Attributes inherited from idEntity
int	entityNumber
int	entityDefNumber
idLinkList< idEntity >	spawnNode
idLinkList< idEntity >	activeNode
idLinkList< idEntity >	snapshotNode
int	snapshotSequence
int	snapshotBits
idStr	name
idDict	spawnArgs
idScriptObject	scriptObject
int	thinkFlags
int	dormantStart
bool	cinematic
renderView_t *	renderView
idEntity *	cameraTarget
idList< idEntityPtr< idEntity > >	targets
int	health
struct idEntity::entityFlags_s	fl
Static Public Attributes inherited from idEntity
static const int	MAX_PVS_AREAS = 4
Protected Attributes inherited from idEntity
renderEntity_t	renderEntity
int	modelDefHandle
refSound_t	refSound

Detailed Description

Definition at line 44 of file Light.h.

Member Enumeration Documentation

anonymous enum

Enumerator
EVENT_BECOMEBROKEN
EVENT_MAXEVENTS

Definition at line 86 of file Light.h.

Constructor & Destructor Documentation

idLight::idLight

(

)

Definition at line 192 of file Light.cpp.

idLight::~idLight

(

)

Definition at line 216 of file Light.cpp.

Member Function Documentation

void idLight::BecomeBroken

(

idEntity *

activator

)

Definition at line 642 of file Light.cpp.

idLight::CLASS_PROTOTYPE

(

idLight

)

void idLight::ClientPredictionThink ( void  )

virtual

Reimplemented from idEntity.

Definition at line 1030 of file Light.cpp.

bool idLight::ClientReceiveEvent ( int  event, int  time, const idBitMsg &  msg  )

virtual

Reimplemented from idEntity.

Definition at line 1140 of file Light.cpp.

void idLight::Event_FadeIn ( float  time )

private

Definition at line 1021 of file Light.cpp.

void idLight::Event_FadeOut ( float  time )

private

Definition at line 1012 of file Light.cpp.

void idLight::Event_GetLightParm ( int  parmnum )

private

Definition at line 856 of file Light.cpp.

void idLight::Event_Hide ( void  )

private

Definition at line 905 of file Light.cpp.

void idLight::Event_Off ( void  )

private

Definition at line 936 of file Light.cpp.

void idLight::Event_On ( void  )

private

Definition at line 927 of file Light.cpp.

void idLight::Event_SetLightParm ( int  parmnum, float  value  )

private

Definition at line 869 of file Light.cpp.

void idLight::Event_SetLightParms ( float  parm0, float  parm1, float  parm2, float  parm3  )

private

Definition at line 878 of file Light.cpp.

void idLight::Event_SetRadius ( float  radius )

private

Definition at line 896 of file Light.cpp.

void idLight::Event_SetRadiusXYZ ( float  x, float  y, float  z  )

private

Definition at line 887 of file Light.cpp.

void idLight::Event_SetShader ( const char *  shadername )

private

Definition at line 847 of file Light.cpp.

void idLight::Event_SetSoundHandles ( void  )

private

Definition at line 981 of file Light.cpp.

void idLight::Event_Show ( void  )

private

Definition at line 916 of file Light.cpp.

void idLight::Event_ToggleOnOff ( idEntity *  activator )

private

Definition at line 945 of file Light.cpp.

void idLight::Fade	(	const idVec4 &	to,
		float	fadeTime
	)

Definition at line 596 of file Light.cpp.

void idLight::FadeIn

(

float

time

)

Definition at line 618 of file Light.cpp.

void idLight::FadeOut

(

float

time

)

Definition at line 609 of file Light.cpp.

void idLight::FreeLightDef ( void  )

virtual

Reimplemented from idEntity.

Definition at line 806 of file Light.cpp.

const idVec3& idLight::GetBaseColor ( void  ) const

inline

Definition at line 67 of file Light.h.

void idLight::GetColor ( idVec3 &  out ) const

virtual

Reimplemented from idEntity.

Definition at line 453 of file Light.cpp.

void idLight::GetColor ( idVec4 &  out ) const

virtual

Reimplemented from idEntity.

Definition at line 464 of file Light.cpp.

qhandle_t idLight::GetLightDefHandle ( void  ) const

inline

Definition at line 80 of file Light.h.

bool idLight::GetPhysicsToSoundTransform ( idVec3 &  origin, idMat3 &  axis  )

virtual

Reimplemented from idEntity.

Definition at line 795 of file Light.cpp.

void idLight::Killed ( idEntity *  inflictor, idEntity *  attacker, int  damage, const idVec3 &  dir, int  location  )

virtual

Reimplemented from idEntity.

Definition at line 633 of file Light.cpp.

void idLight::Off

(

void

)

Definition at line 580 of file Light.cpp.

void idLight::On

(

void

)

Definition at line 563 of file Light.cpp.

void idLight::Present ( void  )

virtual

Reimplemented from idEntity.

Definition at line 737 of file Light.cpp.

void idLight::PresentLightDefChange ( void  )

private

Definition at line 704 of file Light.cpp.

void idLight::PresentModelDefChange ( void  )

private

Definition at line 718 of file Light.cpp.

void idLight::ReadFromSnapshot ( const idBitMsgDelta &  msg )

virtual

Reimplemented from idEntity.

Definition at line 1078 of file Light.cpp.

void idLight::Restore

(

idRestoreGame *

savefile

)

Definition at line 261 of file Light.cpp.

void idLight::Save

(

idSaveGame *

savefile

)

const

Definition at line 229 of file Light.cpp.

void idLight::SaveState

(

idDict *

args

)

Definition at line 818 of file Light.cpp.

void idLight::SetColor ( float  red, float  green, float  blue  )

virtual

Reimplemented from idEntity.

Definition at line 476 of file Light.cpp.

void idLight::SetColor ( const idVec4 &  color )

virtual

Reimplemented from idEntity.

Definition at line 486 of file Light.cpp.

void idLight::SetLightLevel

(

void

)

Definition at line 432 of file Light.cpp.

void idLight::SetLightParent ( idEntity *  lparent )

inline

Definition at line 81 of file Light.h.

void idLight::SetLightParm	(	int	parmnum,
		float	value
	)

Definition at line 509 of file Light.cpp.

void idLight::SetLightParms	(	float	parm0,
		float	parm1,
		float	parm2,
		float	parm3
	)

Definition at line 523 of file Light.cpp.

void idLight::SetRadius

(

float

radius

)

Definition at line 553 of file Light.cpp.

void idLight::SetRadiusXYZ	(	float	x,
		float	y,
		float	z
	)

Definition at line 541 of file Light.cpp.

void idLight::SetShader

(

const char *

shadername

)

Definition at line 498 of file Light.cpp.

void idLight::ShowEditingDialog ( void  )

virtual

Reimplemented from idEntity.

Definition at line 834 of file Light.cpp.

void idLight::Spawn

(

void

)

Definition at line 308 of file Light.cpp.

void idLight::Think ( void  )

virtual

Reimplemented from idEntity.

Definition at line 770 of file Light.cpp.

void idLight::UpdateChangeableSpawnArgs ( const idDict *  source )

virtual

Reimplemented from idEntity.

Definition at line 169 of file Light.cpp.

void idLight::WriteToSnapshot ( idBitMsgDelta &  msg ) const

virtual

Reimplemented from idEntity.

Definition at line 1039 of file Light.cpp.

Member Data Documentation

idVec3 idLight::baseColor

private

Definition at line 104 of file Light.h.

bool idLight::breakOnTrigger

private

Definition at line 105 of file Light.h.

idStr idLight::brokenModel

private

Definition at line 101 of file Light.h.

int idLight::count

private

Definition at line 106 of file Light.h.

int idLight::currentLevel

private

Definition at line 103 of file Light.h.

int idLight::fadeEnd

private

Definition at line 112 of file Light.h.

idVec4 idLight::fadeFrom

private

Definition at line 109 of file Light.h.

int idLight::fadeStart

private

Definition at line 111 of file Light.h.

idVec4 idLight::fadeTo

private

Definition at line 110 of file Light.h.

int idLight::levels

private

Definition at line 102 of file Light.h.

qhandle_t idLight::lightDefHandle

private

Definition at line 100 of file Light.h.

idEntity* idLight::lightParent

private

Definition at line 108 of file Light.h.

idMat3 idLight::localLightAxis

private

Definition at line 99 of file Light.h.

idVec3 idLight::localLightOrigin

private

Definition at line 98 of file Light.h.

renderLight_t idLight::renderLight

private

Definition at line 97 of file Light.h.

bool idLight::soundWasPlaying

private

Definition at line 113 of file Light.h.

int idLight::triggercount

private

Definition at line 107 of file Light.h.

---

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

• neo/d3xp/Light.h
• neo/d3xp/Light.cpp