SCR_BaseAreaMeshComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_BaseAreaMeshComponentClass

Enumerations
enum	EAreaMeshShape { ELLIPSE = 10, RECTANGLE = 20 }

Functions
void	ActivateEveryFrame ()
	Activate the area so it could be updated every frame. More...
void	DeactivateEveryFrame ()
	Deactivate the area. More...
float	GetRadius ()
float	GetHeight ()
EAreaMeshShape	GetShape ()
int	GetResolution ()
void	GetDimensions2D (out float width, out float length)
void	GetDimensions3D (out vector dimensions)
protected vector	GetMeshOffset (IEntity owner)
protected ResourceName	GetMaterial ()
	Get material used for area mesh. More...
void	GenerateAreaMesh ()
	Generate area mesh based on its settings. More...
override void	EOnFrame (IEntity owner, float timeSlice)
override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...

Variables
SCR_BaseAreaMeshComponentClass	PREVIEW_RESOLUTION = 48
protected EAreaMeshShape	m_eShape
protected float	m_fHeight
protected int	m_vResolution
protected bool	m_bFollowTerrain
protected bool	m_bStretchMaterial
protected ResourceName	m_Material
protected bool	m_bActiveEveryFrameOnInit
protected bool	m_bHideInWorkbench
protected vector	m_vLastPos
protected vector	m_vLastDir

Enumeration Type Documentation

EAreaMeshShape

enum EAreaMeshShape

Enumerator
ELLIPSE	Ellipse using Radius and Resolution.
RECTANGLE	Rectangle shape that has a width and length.

Definition at line 255 of file SCR_BaseAreaMeshComponent.c.

Function Documentation

ActivateEveryFrame()

void ActivateEveryFrame

(

)

Activate the area so it could be updated every frame.

Definition at line 40 of file SCR_BaseAreaMeshComponent.c.

DeactivateEveryFrame()

void DeactivateEveryFrame

(

)

Deactivate the area.

Definition at line 47 of file SCR_BaseAreaMeshComponent.c.

EOnFrame()

override void EOnFrame	(	IEntity	owner,
		float	timeSlice
	)

Definition at line 230 of file SCR_BaseAreaMeshComponent.c.

GenerateAreaMesh()

void GenerateAreaMesh

(

)

Generate area mesh based on its settings.

Definition at line 128 of file SCR_BaseAreaMeshComponent.c.

GetDimensions2D()

void GetDimensions2D	(	out float	width,
		out float	length
	)

Returns width and length To be overloaded by inherited classes. By default uses radius as width and length unless function is overwritten

Parameters

[out]	width	Width of Zone (x)
[out]	length	length of Zone (z)

Definition at line 92 of file SCR_BaseAreaMeshComponent.c.

GetDimensions3D()

void GetDimensions3D

(

out vector

dimensions

)

Returns dimensions in vector

Parameters

[out]

dimensions

width, height, length

Definition at line 101 of file SCR_BaseAreaMeshComponent.c.

GetHeight()

float GetHeight

(

)

Get height of the area.

Returns

Height

Definition at line 61 of file SCR_BaseAreaMeshComponent.c.

GetMaterial()

protected ResourceName GetMaterial

(

)

Get material used for area mesh.

Definition at line 121 of file SCR_BaseAreaMeshComponent.c.

GetMeshOffset()

protected vector GetMeshOffset

(

IEntity

owner

)

Get the offset of the AreaMesh. Can be overwritten to set custom position. Only x and z are used. Height is ignored

Parameters

[in]

owner

Returns

Definition at line 114 of file SCR_BaseAreaMeshComponent.c.

GetRadius()

float GetRadius

(

)

Get radius of the area. To be overloaded by inherited classes.

Returns

Radius

Definition at line 21 of file SCR_CampaignBuildingAreaMeshComponent.c.

GetResolution()

int GetResolution

(

)

Get Resolution of the area. Always 4 if Rectangle

Returns

Resolution

Definition at line 78 of file SCR_BaseAreaMeshComponent.c.

GetShape()

EAreaMeshShape GetShape

(

)

Return shape if areaMesh

Returns

Shape Enum

Definition at line 69 of file SCR_BaseAreaMeshComponent.c.

Variable Documentation

m_bActiveEveryFrameOnInit

protected bool m_bActiveEveryFrameOnInit

Definition at line 30 of file SCR_BaseAreaMeshComponent.c.

m_bFollowTerrain

protected bool m_bFollowTerrain

Definition at line 21 of file SCR_BaseAreaMeshComponent.c.

m_bHideInWorkbench

protected bool m_bHideInWorkbench

Definition at line 33 of file SCR_BaseAreaMeshComponent.c.

m_bStretchMaterial

protected bool m_bStretchMaterial

Definition at line 24 of file SCR_BaseAreaMeshComponent.c.

m_eShape

protected EAreaMeshShape m_eShape

Definition at line 12 of file SCR_BaseAreaMeshComponent.c.

m_fHeight

protected float m_fHeight

Definition at line 15 of file SCR_BaseAreaMeshComponent.c.

m_Material

protected ResourceName m_Material

Definition at line 27 of file SCR_BaseAreaMeshComponent.c.

m_vLastDir

protected vector m_vLastDir

Definition at line 36 of file SCR_BaseAreaMeshComponent.c.

m_vLastPos

protected vector m_vLastPos

Definition at line 35 of file SCR_BaseAreaMeshComponent.c.

m_vResolution

protected int m_vResolution

Definition at line 18 of file SCR_BaseAreaMeshComponent.c.

PREVIEW_RESOLUTION

SCR_BaseAreaMeshComponentClass PREVIEW_RESOLUTION = 48