UFO: Alien Invasion
Loading...
Searching...
No Matches
ui_node_model.cpp File Reference

This node allow to include a 3D-model into the GUI. It provide a way to create composite models, check [[How to script UI#How to create a composite model]]. We call it "main model" when a model is a child node of a non model node, and "submodel" when the node is a child node of a model node. More...

#include "../ui_main.h"
#include "../ui_internal.h"
#include "../ui_nodes.h"
#include "../ui_parse.h"
#include "../ui_input.h"
#include "../ui_render.h"
#include "ui_node_model.h"
#include "ui_node_abstractnode.h"
#include "../../client.h"
#include "../../renderer/r_draw.h"
#include "../../renderer/r_mesh.h"
#include "../../renderer/r_mesh_anim.h"
#include "../../renderer/r_model.h"
#include "../../../common/scripts_lua.h"
Include dependency graph for ui_node_model.cpp:

Go to the source code of this file.

Macros

#define EXTRADATA_TYPE   modelExtraData_t
#define EXTRADATA(node)
#define ROTATE_SPEED   0.5
#define MAX_OLDREFVALUE   MAX_VAR

Functions

uiModel_t * UI_GetUIModel (const char *modelName)
 Returns pointer to UI model.
static void UI_ListUIModels_f (void)
void UI_Model_SetModelSource (uiNode_t *node, const char *modelName)
void UI_Model_SetSkinSource (uiNode_t *node, const char *skinName)
void UI_Model_SetAnimationSource (uiNode_t *node, const char *animName)
void UI_Model_SetTagSource (uiNode_t *node, const char *tagName)
static void UI_InitModelInfoView (uiNode_t *node, modelInfo_t *mi, uiModel_t *model)
 Set the Model info view (angle, origin, scale) according to the node definition.
static void UI_DrawModelNodeWithUIModel (uiNode_t *node, const char *source, modelInfo_t *mi, uiModel_t *model)
 Draw a model using UI model definition.
void UI_DrawModelNode (uiNode_t *node, const char *source)
void UI_RegisterModelNode (uiBehaviour_t *behaviour)

Variables

static const uiBehaviour_t * localBehaviour
static vec3_t nullVector = {0, 0, 0}
static int oldMousePosX = 0
static int oldMousePosY = 0

Detailed Description

This node allow to include a 3D-model into the GUI. It provide a way to create composite models, check [[How to script UI#How to create a composite model]]. We call it "main model" when a model is a child node of a non model node, and "submodel" when the node is a child node of a model node.

Definition in file ui_node_model.cpp.

Macro Definition Documentation

◆ EXTRADATA

#define EXTRADATA ( node)
Value:
UI_EXTRADATA(node, EXTRADATA_TYPE)
EXTRADATA_TYPE
#define EXTRADATA_TYPE
Definition ui_node_abstractoption.cpp:38
UI_EXTRADATA
#define UI_EXTRADATA(NODE, TYPE)
Definition ui_nodes.h:185

Definition at line 49 of file ui_node_model.cpp.

Referenced by UI_DrawModelNode(), UI_DrawModelNodeWithUIModel(), and UI_InitModelInfoView().

◆ EXTRADATA_TYPE

#define EXTRADATA_TYPE   modelExtraData_t

Definition at line 48 of file ui_node_model.cpp.

◆ MAX_OLDREFVALUE

#define MAX_OLDREFVALUE   MAX_VAR

Definition at line 52 of file ui_node_model.cpp.

Referenced by uiModelNode::clone(), uiModelNode::doLayout(), uiModelNode::initNodeDynamic(), and UI_DrawModelNode().

◆ ROTATE_SPEED

#define ROTATE_SPEED   0.5

Definition at line 51 of file ui_node_model.cpp.

Referenced by uiGeoscapeNode::onCapturedMouseMove(), uiModelNode::onCapturedMouseMove(), and UI_GeoscapeNodeScroll_f().

Function Documentation

◆ UI_DrawModelNode()

void UI_DrawModelNode ( uiNode_t * node,
const char * source )
Todo
need to merge UI model case, and the common case (looks to be a copy-pasted code)

< We use model extradata

Definition at line 285 of file ui_node_model.cpp.

References modelInfo_t::angles, animState_t::backlerp, modelInfo_t::backlerp, uiNode_t::behaviour, uiNode_t::box, modelInfo_t::center, cl_genericPool, cls, modelInfo_t::color, uiNode_t::color, Com_Error(), Com_Printf(), ERR_DROP, EXTRADATA, uiNode_t::firstChild, animState_t::frame, modelInfo_t::frame, MAX_OLDREFVALUE, MAX_VAR, Mem_Free, Mem_PoolAllocType, modelInfo_t::mesh, modelInfo_t::model, modelInfo_t::name, uiNode_t::next, nullVector, OBJZERO, animState_t::oldframe, modelInfo_t::oldframe, modelInfo_t::origin, uiNode_t::padding, Q_streq, Q_strncpyz(), Q_strnull(), R_AnimChange(), R_AnimGetName(), R_AnimRun(), R_CleanupDepthBuffer(), R_DrawModelDirect(), R_FindModel(), R_ModelAutoScale(), modelInfo_t::scale, uiBox_t::size, modelInfo_t::skin, UI_CheckVisibility(), UI_DrawModelNodeWithUIModel(), UI_GetNodeAbsPos(), UI_GetNodeScreenPos(), UI_GetReferenceString(), UI_GetUIModel(), UI_NodeInstanceOf(), UI_PopClipRect(), UI_PushClipRect(), and VectorMA().

Referenced by uiItemNode::draw(), uiModelNode::draw(), GAME_DisplayItemInfo(), and UI_DrawItem().

◆ UI_DrawModelNodeWithUIModel()

void UI_DrawModelNodeWithUIModel ( uiNode_t * node,
const char * source,
modelInfo_t * mi,
uiModel_t * model )
static

Draw a model using UI model definition.

Definition at line 154 of file ui_node_model.cpp.

References modelInfo_t::angles, uiModel_t::angles, uiModel_t::anim, uiModel_t::animState, animState_t::backlerp, modelInfo_t::backlerp, uiNode_t::box, modelInfo_t::center, uiModel_t::center, cls, modelInfo_t::color, uiModel_t::color, uiNode_t::color, Com_Printf(), EXTRADATA, animState_t::frame, modelInfo_t::frame, modelInfo_t::model, uiModel_t::model, modelInfo_t::name, uiModel_t::next, animState_t::oldframe, modelInfo_t::oldframe, modelInfo_t::origin, uiModel_t::origin, uiNode_t::padding, uiModel_t::parent, uiBox_t::pos, Q_streq, R_AnimChange(), R_AnimGetName(), R_AnimRun(), R_DrawModelDirect(), R_FindModel(), R_ModelAutoScale(), uiNode_t::root, modelInfo_t::scale, uiModel_t::scale, uiBox_t::size, modelInfo_t::skin, uiModel_t::skin, Sys_Error(), uiModel_t::tag, UI_GetReferenceString(), UI_GetUIModel(), UI_InitModelInfoView(), and Vector4Copy.

Referenced by UI_DrawModelNode().

◆ UI_GetUIModel()

uiModel_t * UI_GetUIModel ( const char * modelName)

Returns pointer to UI model.

Parameters
[in]modelNamemodel id from script files
Returns
uiModel_t pointer

Definition at line 61 of file ui_node_model.cpp.

References i, m, Q_streq, and ui_global.

Referenced by GAME_GetModelForItem(), UI_DrawModelNode(), UI_DrawModelNodeWithUIModel(), and UI_ParseUIModel().

◆ UI_InitModelInfoView()

void UI_InitModelInfoView ( uiNode_t * node,
modelInfo_t * mi,
uiModel_t * model )
inlinestatic

Set the Model info view (angle, origin, scale) according to the node definition.

Todo
the param "model" is not used !?

Definition at line 136 of file ui_node_model.cpp.

References modelInfo_t::angles, uiNode_t::box, modelInfo_t::center, EXTRADATA, nullVector, modelInfo_t::origin, modelInfo_t::scale, scale, uiBox_t::size, UI_GetNodeAbsPos(), and VectorCopy.

Referenced by UI_DrawModelNodeWithUIModel().

◆ UI_ListUIModels_f()

void UI_ListUIModels_f ( void )
static

Definition at line 71 of file ui_node_model.cpp.

References Com_Printf(), i, m, and ui_global.

Referenced by UI_RegisterModelNode().

◆ UI_Model_SetAnimationSource()

void UI_Model_SetAnimationSource ( uiNode_t * node,
const char * animName )

Definition at line 92 of file ui_node_model.cpp.

References Mem_PoolStrDup, ui_dynStringPool, UI_EXTRADATA, and UI_FreeStringProperty().

Referenced by uiModelNode_t_set_animation().

◆ UI_Model_SetModelSource()

void UI_Model_SetModelSource ( uiNode_t * node,
const char * modelName )

Definition at line 82 of file ui_node_model.cpp.

References Mem_PoolStrDup, ui_dynStringPool, UI_EXTRADATA, and UI_FreeStringProperty().

Referenced by uiModelNode_t_set_model().

◆ UI_Model_SetSkinSource()

void UI_Model_SetSkinSource ( uiNode_t * node,
const char * skinName )

Definition at line 87 of file ui_node_model.cpp.

References Mem_PoolStrDup, ui_dynStringPool, UI_EXTRADATA, and UI_FreeStringProperty().

Referenced by uiModelNode_t_set_skin().

◆ UI_Model_SetTagSource()

void UI_Model_SetTagSource ( uiNode_t * node,
const char * tagName )

Definition at line 97 of file ui_node_model.cpp.

References Mem_PoolStrDup, ui_dynStringPool, UI_EXTRADATA, and UI_FreeStringProperty().

Referenced by uiModelNode_t_set_tag().

◆ UI_RegisterModelNode()

void UI_RegisterModelNode ( uiBehaviour_t * behaviour)

Definition at line 528 of file ui_node_model.cpp.

References Cmd_AddCommand(), uiBehaviour_t::drawItselfChild, EXTRADATA_TYPE, uiBehaviour_t::extraDataSize, localBehaviour, uiBehaviour_t::lua_SWIG_typeinfo, uiBehaviour_t::manager, uiBehaviour_t::name, scale, UI_ListUIModels_f(), UI_RegisterExtradataNodeProperty, UI_SWIG_TypeQuery(), V_BOOL, V_CVAR_OR_STRING, and V_VECTOR.

Variable Documentation

◆ localBehaviour

const uiBehaviour_t* localBehaviour
static

Definition at line 54 of file ui_node_model.cpp.

Referenced by UI_RegisterModelNode(), UI_RegisterPanelNode(), and UI_RegisterSequenceNode().

◆ nullVector

vec3_t nullVector = {0, 0, 0}
static

Definition at line 130 of file ui_node_model.cpp.

Referenced by UI_DrawModelNode(), and UI_InitModelInfoView().

◆ oldMousePosX

int oldMousePosX = 0
static

Definition at line 447 of file ui_node_model.cpp.

◆ oldMousePosY

int oldMousePosY = 0
static

Definition at line 448 of file ui_node_model.cpp.