SCR_PrefabBoneSnappingTool Interface Reference

Inheritance diagram for SCR_PrefabBoneSnappingTool:

Protected Member Functions
IEntitySource	GetDragAndDroppedEntitySource ()
void	RefreshState (bool showError)
bool	RefreshEntitySources (bool showError)
void	RefreshBoneMatrixMap ()
	Fill BONE_MATRICES according to model's bones Also draws bone debug if the option is set Requires m_EditedEntitySource.
void	RefreshDebugShapes ()
void	RefreshBoneEntitySourceMap ()
	Fill BONE_MATRICES according to model's bones Requires m_EditedEntitySource.
void	SnapNewEntitySource (notnull IEntitySource newEntitySource)
void	UpdateDebugShapes (float x, float y)
override void	OnKeyPressEvent (KeyCode key, bool isAutoRepeat)
override void	OnLeaveEvent ()
override void	OnMouseMoveEvent (float x, float y)
override void	OnMousePressEvent (float x, float y, WETMouseButtonFlag buttons)
override void	OnActivate ()
override void	OnDeActivate ()
override void	OnAfterLoadWorld ()
override void	OnBeforeUnloadWorld ()
void	ButtonRefresh ()
void	ButtonOpenPrefabInEditMode ()

Protected Attributes
bool	m_bDrawDebugShapes
float	m_fBoneDebugSphereRadius
IEntitySource	m_WorldEntitySource
IEntitySource	m_EditedEntitySource
int	m_iX = INVALID_CURSOR_POS
int	m_iY = INVALID_CURSOR_POS
ref SCR_DebugShapeManager	m_DebugShapeManager = new SCR_DebugShapeManager()

Static Protected Attributes
const ref map< string, ref array< vector > >	BONE_MATRICES = new map<string, ref array<vector>>()
const ref map< string, IEntitySource >	BONE_ENTITYSOURCES = new map<string, IEntitySource>()
const ref map< string, ref DebugTextScreenSpace >	BONE_DEBUGTEXTS = new map<string, ref DebugTextScreenSpace>()
const ref map< string, Shape >	BONE_DEBUGSHAPES = new map<string, Shape>()
static const int	INVALID_CURSOR_POS = -1
static const int	BONE_SPHERE_COLOUR = 0x8855FF00
static const int	BONE_SPHERE_COLOUR_HIGHLIGHT = 0xFFFFFF00
static const float	BONE_TEXT_SIZE = 12
static const int	BONE_TEXT_COLOUR = 0xFFFFFFFF
static const int	BONE_TEXT_COLOUR_BACKGROUND = 0xFF000000
static const string	SCENE_ROOT_BONE = "Scene_Root"
static const int	ROOT_BONE_SPHERE_COLOUR = 0x88FFAA55
static const float	ROOT_BONE_SPHERE_RADIUS = 0.05

Member Function Documentation

ButtonOpenPrefabInEditMode()

void SCR_PrefabBoneSnappingTool.ButtonOpenPrefabInEditMode ( )

protected

ButtonRefresh()

void SCR_PrefabBoneSnappingTool.ButtonRefresh ( )

protected

GetDragAndDroppedEntitySource()

IEntitySource SCR_PrefabBoneSnappingTool.GetDragAndDroppedEntitySource ( )

protected

Returns

the drag&dropped entitySource or null if not found (some bug somewhere)

OnActivate()

override void SCR_PrefabBoneSnappingTool.OnActivate ( )

protected

OnAfterLoadWorld()

override void SCR_PrefabBoneSnappingTool.OnAfterLoadWorld ( )

protected

OnBeforeUnloadWorld()

override void SCR_PrefabBoneSnappingTool.OnBeforeUnloadWorld ( )

protected

OnDeActivate()

override void SCR_PrefabBoneSnappingTool.OnDeActivate ( )

protected

OnKeyPressEvent()

override void SCR_PrefabBoneSnappingTool.OnKeyPressEvent ( KeyCode key, bool isAutoRepeat )

protected

OnLeaveEvent()

override void SCR_PrefabBoneSnappingTool.OnLeaveEvent ( )

protected

OnMouseMoveEvent()

override void SCR_PrefabBoneSnappingTool.OnMouseMoveEvent ( float x, float y )

protected

OnMousePressEvent()

override void SCR_PrefabBoneSnappingTool.OnMousePressEvent ( float x, float y, WETMouseButtonFlag buttons )

protected

RefreshBoneEntitySourceMap()

void SCR_PrefabBoneSnappingTool.RefreshBoneEntitySourceMap ( )

protected

Fill BONE_MATRICES according to model's bones Requires m_EditedEntitySource.

RefreshBoneMatrixMap()

void SCR_PrefabBoneSnappingTool.RefreshBoneMatrixMap ( )

protected

Fill BONE_MATRICES according to model's bones Also draws bone debug if the option is set Requires m_EditedEntitySource.

RefreshDebugShapes()

void SCR_PrefabBoneSnappingTool.RefreshDebugShapes ( )

protected

RefreshEntitySources()

bool SCR_PrefabBoneSnappingTool.RefreshEntitySources ( bool showError )

protected

Returns

true if world and Prefab entity sources have been found, false otherwise

RefreshState()

void SCR_PrefabBoneSnappingTool.RefreshState ( bool showError )

protected

SnapNewEntitySource()

void SCR_PrefabBoneSnappingTool.SnapNewEntitySource ( notnull IEntitySource newEntitySource )

protected

Parameters

[in]

newEntitySource

UpdateDebugShapes()

void SCR_PrefabBoneSnappingTool.UpdateDebugShapes ( float x, float y )

protected

Member Data Documentation

BONE_DEBUGSHAPES

const ref map<string, Shape> SCR_PrefabBoneSnappingTool.BONE_DEBUGSHAPES = new map<string, Shape>()

staticprotected

BONE_DEBUGTEXTS

const ref map<string, ref DebugTextScreenSpace> SCR_PrefabBoneSnappingTool.BONE_DEBUGTEXTS = new map<string, ref DebugTextScreenSpace>()

staticprotected

BONE_ENTITYSOURCES

const ref map<string, IEntitySource> SCR_PrefabBoneSnappingTool.BONE_ENTITYSOURCES = new map<string, IEntitySource>()

staticprotected

BONE_MATRICES

const ref map<string, ref array<vector> > SCR_PrefabBoneSnappingTool.BONE_MATRICES = new map<string, ref array<vector>>()

staticprotected

BONE_SPHERE_COLOUR

const int SCR_PrefabBoneSnappingTool.BONE_SPHERE_COLOUR = 0x8855FF00

staticprotected

BONE_SPHERE_COLOUR_HIGHLIGHT

const int SCR_PrefabBoneSnappingTool.BONE_SPHERE_COLOUR_HIGHLIGHT = 0xFFFFFF00

staticprotected

BONE_TEXT_COLOUR

const int SCR_PrefabBoneSnappingTool.BONE_TEXT_COLOUR = 0xFFFFFFFF

staticprotected

BONE_TEXT_COLOUR_BACKGROUND

const int SCR_PrefabBoneSnappingTool.BONE_TEXT_COLOUR_BACKGROUND = 0xFF000000

staticprotected

BONE_TEXT_SIZE

const float SCR_PrefabBoneSnappingTool.BONE_TEXT_SIZE = 12

staticprotected

INVALID_CURSOR_POS

const int SCR_PrefabBoneSnappingTool.INVALID_CURSOR_POS = -1

staticprotected

m_bDrawDebugShapes

bool SCR_PrefabBoneSnappingTool.m_bDrawDebugShapes

protected

m_DebugShapeManager

ref SCR_DebugShapeManager SCR_PrefabBoneSnappingTool.m_DebugShapeManager = new SCR_DebugShapeManager()

protected

m_EditedEntitySource

IEntitySource SCR_PrefabBoneSnappingTool.m_EditedEntitySource

protected

m_fBoneDebugSphereRadius

float SCR_PrefabBoneSnappingTool.m_fBoneDebugSphereRadius

protected

m_iX

int SCR_PrefabBoneSnappingTool.m_iX = INVALID_CURSOR_POS

protected

m_iY

int SCR_PrefabBoneSnappingTool.m_iY = INVALID_CURSOR_POS

protected

m_WorldEntitySource

IEntitySource SCR_PrefabBoneSnappingTool.m_WorldEntitySource

protected

ROOT_BONE_SPHERE_COLOUR

const int SCR_PrefabBoneSnappingTool.ROOT_BONE_SPHERE_COLOUR = 0x88FFAA55

staticprotected

ROOT_BONE_SPHERE_RADIUS

const float SCR_PrefabBoneSnappingTool.ROOT_BONE_SPHERE_RADIUS = 0.05

staticprotected

SCENE_ROOT_BONE

const string SCR_PrefabBoneSnappingTool.SCENE_ROOT_BONE = "Scene_Root"

staticprotected

---

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

• WorkbenchGame/WorldEditor/SCR_PrefabBoneSnappingTool.c