SCR_CoordsTool Interface Reference

Inheritance diagram for SCR_CoordsTool:

Protected Member Functions
void	SetCamera (vector pos, vector rot)
	Sets world editor camera position and rotation.
bool	GetCoordsFromInput (string input, out vector pos, out vector rot)
	Parses string for coordinates and returns true in case of success, false otherwise.
bool	GetCoordsFromString (string input, out vector pos, out vector rot)
bool	GetCoordsFromMapCoordsString (string input, out vector pos, out vector rot)
void	AddEntry ()
void	NavigateToClipboardLink ()
void	NavigateToCoords ()
	When clicked by the user, sets the camera to desired position.

Protected Attributes
vector	m_vPosition
vector	m_vRotation
string	m_sMapCoordinates
bool	m_bUseFullLink
ref array< ref SCR_CoordsTool_CoordsEntry >	m_aEntries

Static Protected Attributes
static const float	MIN_CAMERA_Y = 5
static const string	WEB_PREFIX = "https://enfusionengine.com/api/redirect?to="
static const string	PLUGIN_NAME = "Coords Tool"

Member Function Documentation

AddEntry()

void SCR_CoordsTool.AddEntry ( )

protected

GetCoordsFromInput()

bool SCR_CoordsTool.GetCoordsFromInput ( string input, out vector pos, out vector rot )

protected

Parses string for coordinates and returns true in case of success, false otherwise.

Parameters

[in]	input	link format (https://enfusionengine.com/api/redirect?to=)enfusion://, X,Y,Z;Pitch,Yaw,Roll or map coordinates (e.g 123 456)
[out]	pos	position
[out]	rot	rotation

Returns

coordinates extraction success status

GetCoordsFromMapCoordsString()

bool SCR_CoordsTool.GetCoordsFromMapCoordsString ( string input, out vector pos, out vector rot )

protected

GetCoordsFromString()

bool SCR_CoordsTool.GetCoordsFromString ( string input, out vector pos, out vector rot )

protected

NavigateToClipboardLink()

void SCR_CoordsTool.NavigateToClipboardLink ( )

protected

NavigateToCoords()

void SCR_CoordsTool.NavigateToCoords ( )

protected

When clicked by the user, sets the camera to desired position.

SetCamera()

void SCR_CoordsTool.SetCamera ( vector pos, vector rot )

protected

Sets world editor camera position and rotation.

Parameters

[in]	pos	Position in world space.
[in]	rot	Rotation as pitch, yaw, roll in degrees.

Member Data Documentation

m_aEntries

ref array<ref SCR_CoordsTool_CoordsEntry> SCR_CoordsTool.m_aEntries

protected

m_bUseFullLink

bool SCR_CoordsTool.m_bUseFullLink

protected

m_sMapCoordinates

string SCR_CoordsTool.m_sMapCoordinates

protected

m_vPosition

vector SCR_CoordsTool.m_vPosition

protected

m_vRotation

vector SCR_CoordsTool.m_vRotation

protected

MIN_CAMERA_Y

const float SCR_CoordsTool.MIN_CAMERA_Y = 5

staticprotected

PLUGIN_NAME

const string SCR_CoordsTool.PLUGIN_NAME = "Coords Tool"

staticprotected

WEB_PREFIX

const string SCR_CoordsTool.WEB_PREFIX = "https://enfusionengine.com/api/redirect?to="

staticprotected

---

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

• WorkbenchGame/WorldEditor/SCR_CoordsTool.c