SCR_CoordsTool Interface Reference

Inheritance diagram for SCR_CoordsTool:

Static Public Member Functions
static string	GetWorldEditorLink (vector transformation[4], bool useWebPrefix=false)
	Get a World Editor link in Enfusion protocol format.

Protected Member Functions
void	SetCamera (vector pos, vector rot)
	Sets world editor camera position and rotation.
bool	GetCoordsFromInput (string coordsLink, out vector pos, out vector rot)
	Parses string for coordinates and returns true in case of success, false otherwise.
void	AddEntry ()
	When clicked by the user, sets the camera to desired position.
void	CopyLinkToClipboard ()
	Copies current transform and generates enfusion link, which is copied to clipboard.
void	NavigateToClipboardLink ()
void	NavigateToCoords ()
	When clicked by the user, sets the camera to desired position.

Static Protected Member Functions
static string	GetCurrentWorldEditorLink (bool useWebPrefix)

Protected Attributes
vector	m_vPosition
vector	m_vRotation
bool	m_bUseWebPrefix
ref array< ref SCR_CoordsTool_CoordsEntry >	m_aEntries

Static Protected Attributes
static const string	WEB_PREFIX = "https:/" + "/enfusionengine.com/api/redirect?to="

Member Function Documentation

AddEntry()

void SCR_CoordsTool.AddEntry ( )

protected

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

CopyLinkToClipboard()

void SCR_CoordsTool.CopyLinkToClipboard ( )

protected

Copies current transform and generates enfusion link, which is copied to clipboard.

GetCoordsFromInput()

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

protected

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

Parameters

[in]	coordsLink	link format enfusion://, https://enfusionengine.com/api/redirect?to=, or X,Y,Z;Pitch,Yaw,Roll
[out]	pos	position
[out]	rot	rotation

Returns

coordinates extraction success status

GetCurrentWorldEditorLink()

static string SCR_CoordsTool.GetCurrentWorldEditorLink ( bool useWebPrefix )

staticprotected

GetWorldEditorLink()

static string SCR_CoordsTool.GetWorldEditorLink ( vector transformation[4], bool useWebPrefix = false )

static

Get a World Editor link in Enfusion protocol format.

Parameters

[in]

transformation

The transformation to create the link at.

Returns

Enfusion protocol link, with or without the enfusionengine.com prefix

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_bUseWebPrefix

bool SCR_CoordsTool.m_bUseWebPrefix

protected

m_vPosition

vector SCR_CoordsTool.m_vPosition

protected

m_vRotation

vector SCR_CoordsTool.m_vRotation

protected

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