SCR_SpherePointGeneratorPreviewComponent Interface Reference

Inheritance diagram for SCR_SpherePointGeneratorPreviewComponent:

Public Member Functions
override void	_WB_OnInit (IEntity owner, inout vector mat[4], IEntitySource src)
	Draws debug preview shapes in Workbench.
override bool	_WB_OnKeyChanged (IEntity owner, BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)
	Any property value has been changed. You can use editor API here and do some additional edit actions which will be part of the same "key changed" action.
override void	OnDelete (IEntity owner)
	Called when Entity is being to be destroyed (deleted) or component to be deleted (see Game.DeleteScriptComponent).

Public Attributes
ref array< float >	m_aSphereRadii
float	m_fPointSize
int	m_iMaxPoints
float	m_fSpacing
ref array< int >	m_aPointAmounts
ref Color	m_BaseColor
bool	m_bHueShiftByIndex
bool	m_bHueShiftBySphere
bool	m_bShowIndex

Protected Member Functions
override void	OnPostInit (IEntity owner)
void	DrawPreview ()
	Draws preview spheres with varying radii, colors, and indices on the specified position.
string	GetInstanceId ()
	The name of the entity this component is in.

Static Protected Member Functions
static set< string >	GetKeyUpdateSet ()

Protected Attributes
string	m_sInstanceId

Static Protected Attributes
static const int	PREVIEW_POINT_BUDGET = 100000
static ref set< string >	s_KeyUpdateSet

Member Function Documentation

_WB_OnInit()

override void SCR_SpherePointGeneratorPreviewComponent._WB_OnInit	(	IEntity	owner,
		inout vector	mat[4],
		IEntitySource	src )

Draws debug preview shapes in Workbench.

_WB_OnKeyChanged()

override bool SCR_SpherePointGeneratorPreviewComponent._WB_OnKeyChanged	(	IEntity	owner,
		BaseContainer	src,
		string	key,
		BaseContainerList	ownerContainers,
		IEntity	parent )

Any property value has been changed. You can use editor API here and do some additional edit actions which will be part of the same "key changed" action.

DrawPreview()

void SCR_SpherePointGeneratorPreviewComponent.DrawPreview ( )

protected

Draws preview spheres with varying radii, colors, and indices on the specified position.

Should be called on creation or init.

GetInstanceId()

string SCR_SpherePointGeneratorPreviewComponent.GetInstanceId ( )

protected

The name of the entity this component is in.

By Default its empty unless named by mission creator. Duplicates would just result in only one SCR_SpherePointGeneratorPreviewComponent being drawn.

Returns

Instance ID usable for SCR_DebugShapeHelperComponent tags.

GetKeyUpdateSet()

static set< string > SCR_SpherePointGeneratorPreviewComponent.GetKeyUpdateSet ( )

staticprotected

Returns

A set of keys for updating properties.

OnDelete()

override void SCR_SpherePointGeneratorPreviewComponent.OnDelete

(

IEntity

owner

)

Called when Entity is being to be destroyed (deleted) or component to be deleted (see Game.DeleteScriptComponent).

param[in] owner Entity which owns the component

OnPostInit()

override void SCR_SpherePointGeneratorPreviewComponent.OnPostInit ( IEntity owner )

protected

Parameters

[in]

owner

The owner represents the entity being initialized in the method, which is used to set event mask and clear debug elements.

Member Data Documentation

m_aPointAmounts

ref array<int> SCR_SpherePointGeneratorPreviewComponent.m_aPointAmounts

m_aSphereRadii

ref array<float> SCR_SpherePointGeneratorPreviewComponent.m_aSphereRadii

m_BaseColor

ref Color SCR_SpherePointGeneratorPreviewComponent.m_BaseColor

m_bHueShiftByIndex

bool SCR_SpherePointGeneratorPreviewComponent.m_bHueShiftByIndex

m_bHueShiftBySphere

bool SCR_SpherePointGeneratorPreviewComponent.m_bHueShiftBySphere

m_bShowIndex

bool SCR_SpherePointGeneratorPreviewComponent.m_bShowIndex

m_fPointSize

float SCR_SpherePointGeneratorPreviewComponent.m_fPointSize

m_fSpacing

float SCR_SpherePointGeneratorPreviewComponent.m_fSpacing

m_iMaxPoints

int SCR_SpherePointGeneratorPreviewComponent.m_iMaxPoints

m_sInstanceId

string SCR_SpherePointGeneratorPreviewComponent.m_sInstanceId

protected

PREVIEW_POINT_BUDGET

const int SCR_SpherePointGeneratorPreviewComponent.PREVIEW_POINT_BUDGET = 100000

staticprotected

s_KeyUpdateSet

ref set<string> SCR_SpherePointGeneratorPreviewComponent.s_KeyUpdateSet

staticprotected

---

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

• Game/Components/Helpers/SCR_SpherePointGeneratorPreviewComponent.c