SCR_BaseAreaMeshComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_BaseAreaMeshComponentClass

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

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

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

Enumeration Type Documentation

EAreaMeshShape

enum EAreaMeshShape

protected

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 ( )

protected

Activate the area so it could be updated every frame.

Definition at line 40 of file SCR_BaseAreaMeshComponent.c.

DeactivateEveryFrame()

void DeactivateEveryFrame ( )

protected

Deactivate the area.

Definition at line 47 of file SCR_BaseAreaMeshComponent.c.

EOnFrame()

override void EOnFrame ( IEntity owner, float timeSlice )

protected

Definition at line 230 of file SCR_BaseAreaMeshComponent.c.

GenerateAreaMesh()

void GenerateAreaMesh ( )

protected

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 )

protected

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 )

protected

Returns dimensions in vector

Parameters

[out]

dimensions

width, height, length

Definition at line 101 of file SCR_BaseAreaMeshComponent.c.

GetHeight()

float GetHeight ( )

protected

Get height of the area.

Returns

Height

Definition at line 61 of file SCR_BaseAreaMeshComponent.c.

GetMaterial()

ResourceName GetMaterial ( )

protected

Get material used for area mesh.

Definition at line 121 of file SCR_BaseAreaMeshComponent.c.

GetMeshOffset()

vector GetMeshOffset ( IEntity owner )

protected

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 ( )

protected

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 ( )

protected

Get Resolution of the area. Always 4 if Rectangle

Returns

Resolution

Definition at line 78 of file SCR_BaseAreaMeshComponent.c.

GetShape()

EAreaMeshShape GetShape ( )

protected

Return shape if areaMesh

Returns

Shape Enum

Definition at line 69 of file SCR_BaseAreaMeshComponent.c.

Variable Documentation

m_bActiveEveryFrameOnInit

bool m_bActiveEveryFrameOnInit

protected

Definition at line 30 of file SCR_BaseAreaMeshComponent.c.

m_bFollowTerrain

bool m_bFollowTerrain

protected

Definition at line 21 of file SCR_BaseAreaMeshComponent.c.

m_bHideInWorkbench

bool m_bHideInWorkbench

protected

Definition at line 33 of file SCR_BaseAreaMeshComponent.c.

m_bStretchMaterial

bool m_bStretchMaterial

protected

Definition at line 24 of file SCR_BaseAreaMeshComponent.c.

m_eShape

EAreaMeshShape m_eShape

protected

Definition at line 12 of file SCR_BaseAreaMeshComponent.c.

m_fHeight

float m_fHeight

protected

Definition at line 15 of file SCR_BaseAreaMeshComponent.c.

m_Material

ResourceName m_Material

protected

Definition at line 27 of file SCR_BaseAreaMeshComponent.c.

m_vLastDir

vector m_vLastDir

protected

Definition at line 36 of file SCR_BaseAreaMeshComponent.c.

m_vLastPos

vector m_vLastPos

protected

Definition at line 35 of file SCR_BaseAreaMeshComponent.c.

m_vResolution

int m_vResolution

protected

Definition at line 18 of file SCR_BaseAreaMeshComponent.c.

PREVIEW_RESOLUTION

SCR_BaseAreaMeshComponentClass PREVIEW_RESOLUTION = 48