This page has been translated automatically.
Click here to view the original English version instead.
Getting Started
What's Inside?
Project Workflow
Basic Tutorial: Importing FBX Model
System Requirements
Principles of Operation
Virtual World Structure
World Management
Rendering
Rendering Sequence
Scattering
PSSM
Temporal Anti-Aliasing
Alpha Blending
Hiding Shading Artifacts with AppBorder Plugin
Physics
Shapes
Collision Detection
Joints
Simulation of Physics
Bit Masking
File System
SDK Browser
Projects
Licenses
Add-Ons
Game Framework Add-On
Kinect2 Add-On
Tutorials Content Add-On
Vegetation Add-On
VRPN Add-On
UnigineEditor
Overview
Controls
Managing Worlds
Scene Navigation
Setting Up Cameras
Importing Nodes
Selecting and Positioning Nodes
Organizing Nodes
Exporting Nodes
Rendering Settings
Common
Parameters
TAA
SSAO
SSGI
SSS
SSR
Water SSR
Clouds
Environment
Postprocess
DOF
Camera Effects
Color
Setting Up Materials
Setting Up Properties
Setting Up Physics
Terrain Editor
Terrain Grabber
Landscape Tool
System Menu
Video Grabber
Mask Editor
Tools Panel
LUT Generation Tool
Plugins
Collada Import Plugin
OpenFlight Import Plugin
Importing Large Populated Areas with City Import Plugin
Making Environment Look Realistic with Randomizer Plugin
Exporting Nodes with Node Export Plugin
Baking Meshes into One Mesh with Mesh Combiner Plugin
Creating Large Terrains with Landscape Plugin
Interface Plugin
Making Custom Editor Plugins
Tools
Plugins for 3D Editors
Plugins for 3ds Max
Plugins for Maya
Performance Profiling Tools
Performance Profiler
Microprofile
ResourceEditor
MeshViewer
NormalCombiner
NormalMapper
AmbientMapper
AlphaMapper
ImageDDS
ImageTTF
USC Interpreter
Archiver
Resource
MeshImport
Upgrade Script
Built-in Node Types
Nodes
Node
Node Reference
Dummy Node
Layer
Pivot
Trigger
Objects
Dummy Object
Static Mesh
Skinned Mesh
Dynamic Mesh
Mesh Cluster
Mesh Clutter
Text Object
Sky
Cloud Layer
Effects
Particle System
Decals
Projected Decal
Orthographic Decal
Mesh Decal
Light Sources
Light Sources Parameters
Omni Light
Projected Light
World Light
Environment Probe
Geodetics
Geodetic Pivot
World Objects
World Layer
Sector
Portal
World Trigger
World Cluster
World Clutter
Switcher
World Expression
Sound Objects
Sound Source
Sound Reverb
Pathfinding Objects
Players
Player Actor
Player Dummy
Player Persecutor
Player Spectator
Programming
Fundamentals
Programming Overview
Engine Architecture
Typical Architecture of a Unigine-Based Application
Memory Management
Matrix Transformations
Setting Up Development Environment
Windows Development Environment
Linux Development Environment
OS X Development Environment
UnigineScript
Creating UnigineScript Application
Adding Scripts to the Project
Script Debugging
High-Level Systems
UnigineScript Basic Utilities
Unigine::Schemer
Unigine::Skinner
Input System
Character System
KeyLine System
Dialogs Script
Cache Files
C++
Creating C++ Application
Creating C++ Plugin
C#
Creating C# Application
C# API Reference
UUSL (Unified UNIGINE Shader Language)
UUSL Keywords
UUSL Common Intrinsic Functions
UUSL GBuffer Structure
UUSL Data Structure
UUSL Parameters
UUSL Textures
UUSL Semantics
UUSL Tessellation
UUSL Compute Shaders
Creating a Custom Shader for Deferred Rendering Pass
Creating a Custom Shader for Forward Rendering Pass
Creating a Custom Shader for Post-Processing
File Formats
Mesh File Formats
Material File Format
Property File Format
Startup Command-Line Options
Console
Configuration File
Rebuilding the Engine and Tools
Rebuild in Windows via Visual Studio
Rebuild in OS X via Xcode
Semi-automatic Compilation with Build Script
Manual Compilation with SCons
Preprocessor Macros for Rebuilding the Engine
Rebuild Qt Libraries
Protecting Your Data with a Password
GUI
RC Files
Skin Layout
Usage Example
Double Precision Coordinates
Usage
Performance Analyzer
How to Generate Shaders Cache
API
Containers
Container Functions
ArrayVector Class
Map Class
Set Class
Common Functionality
Async Class
Atomiclock Class
Blob Class
CallbackBase Class
Checksum Class
Compress Class
ConsoleVariableFloat Class
ConsoleVariableInt Class
ConsoleVariableString Class
Expression Class
ExternClass Class
FunctionBase Class
Image Class
Interpreter Class
Json Class
Log Class
OS Functions
Path Class
Plugin Class
Property Class
Ptr Class
Reflection Class
RegExp Class
Resource Class
Stream Class
String Class
System Functions
Thread Class
Timer Class
TypeInfo Class
Unigine Namespace Items
Utils Class
Xml Class
Variable Class
Controls-Related Classes
Controls Class
ControlsApp Class
ControlsDummy Class
ControlsJoystick Class
ControlsSixAxis
ControlsXPad360 Class
Engine-Related Classes
App Class
Config Class
Console Class
Editor Class
Engine Class
EnginePtr Class
engine.system Functions
EnginePlugins Class
Game Class
GameIntersection Class
Memory Class
Profiler Class
Properties Class
Sound Class
Sounds Class
Splash Class
Visualizer Class
World Class
Filesystem Functionality
Dir Class
File Class
Filesystem Class
File System Functions
Package Class
PackageUng Class
GUI-Related Classes
Gui Class
UserInterface Class
Widget Class
WidgetButton Class
WidgetCanvas Class
WidgetCheckBox Class
WidgetComboBox Class
WidgetDialog Class
WidgetDialogColor Class
WidgetDialogFile Class
WidgetDialogImage Class
WidgetDialogMessage Class
WidgetEditLine Class
WidgetEditText Class
WidgetExternBase Class
WidgetExtern Class
WidgetGridBox Class
WidgetGroupBox Class
WidgetHBox Class
WidgetHPaned Class
WidgetIcon Class
WidgetLabel Class
WidgetListBox Class
WidgetManipulator Class
WidgetManipulatorRotator Class
WidgetManipulatorScaler Class
WidgetManipulatorTranslator Class
WidgetMenuBar Class
WidgetMenuBox Class
WidgetScroll Class
WidgetScrollBox Class
WidgetSlider Class
WidgetSpacer Class
WidgetSpinBox Class
WidgetSprite Class
WidgetSpriteNode Class
WidgetSpriteShader Class
WidgetSpriteVideo Class
WidgetSpriteViewport Class
WidgetTabBox Class
WidgetTreeBox Class
WidgetVBox Class
WidgetVPaned Class
WidgetWindow Class
Math Functionality
Predefined Constants
Geometry Class
Math Common Functions
Math Exponential Functions
Math Matrix Functions
Math Random Functions
Math Trigonometrical Functions
bvec4 Class
dmat4 Class
dvec2 Class
dvec3 Class
dvec4 Class
half Class
hvec2 Class
hvec3 Class
hvec4 Class
ivec2 Class
ivec3 Class
ivec4 Class
mat2 Class
mat3 Class
mat4 Class
quat Class
vec2 Class
vec3 Class
vec4 Class
Node-Related Classes
Node Class
NodeDummy Class
NodeExtern Class
NodeExternBase Class
NodeLayer Class
NodePivot Class
NodeReference Class
NodeTrigger Class
Networking Functionality
Socket Class
Pathfinding-Related Classes
Navigation Class
NavigationMesh Class
NavigationSector Class
Obstacle Class
ObstacleBox Class
ObstacleCapsule Class
ObstacleSphere Class
PathRoute Class
PathRouteIntersection Class
Physics-Related Classes
Physics Class
PhysicsIntersection Class
PhysicsIntersectionNormal Class
Plugins-Related Classes
AutodeskImport Class
ColladaImport Class
OpenFlightImport Class
engine.border Functions
engine.grabber Functions
engine.kinect Functions
engine.oculus Functions
engine.projection Functions
engine.surround Functions
engine.vive Functions
engine.wall Functions
Rendering-Related Classes
Camera Class
Ffp Class
Material Class
Materials Class
Mesh Class
Primitives Class
Render Class
Renderer Class
RenderState Class
Shader Class
StructuredBuffer Class
Texture Class
TextureRender Class
Viewport Class
Content Creation
3D Models Requirements
Art Assets Conversion
Content Optimization
Materials
Hierarchy and Inheritance
Custom Materials
Tutorials
Adding Morph Targets
Setting Up Object LODs
Adding Impostors to Clutters
Unigine Demos
Migrating to UNIGINE 2.4.1
API Migration
Table of Contents
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine::WidgetMenuBox Class

Header:#include <UnigineWidgets.h>
Inherits:Widget

List of functions:

This class creates a menu box. It can be either stand-alone or attached to a menu bar. In the first case it needs to be handled manually. By using this widget, you can do the following:

  • Create hierarchical menus.
  • Use the other widgets as menu items (See the example).

WidgetMenuBox Class

Members

static WidgetMenuBoxPtr create(const Ptr<Gui> & gui, int x = 0, int y = 0)

Constructor. Creates an empty menu box with specified spacing between menu items and items and menu borders.

Arguments

  • const Ptr<Gui> & gui - GUI, to which the menu will belong.
  • int x - Horizontal space.
  • int y - Vertical space.

Ptr<WidgetMenuBox> cast(const Ptr<Widget> & widget)

Arguments

  • const Ptr<Widget> & widget

int getCurrentItem()

Returns the item, which is currently in focus.

Return value

Item number.

const char * getCurrentItemData()

Returns the data of the item, which is currently in focus. The data can be used as a text identifier of the item (instead of using the number of the item).

Return value

Item data if the item is in range from 0 to the total number of items; otherwise, NULL.

const char * getCurrentItemText()

Returns the text of the item, which is currently in focus.

Return value

Item text if the item is in range from 0 to the total number of items; otherwise, NULL.

void setImage(const Ptr<Image> & image)

Sets an image with mini-icons to be used with items. The image is a vertical strip of square icons.

Arguments

  • const Ptr<Image> & image - Image to set.

void getImage(const Ptr<Image> & image)

Gets the image with mini-icons, which are used with menu items.

Arguments

  • const Ptr<Image> & image - Image with mini-icons (the vertical strip of square icons).

void setItemData(int item, const char * str)

Sets the data for a given item. The data can be used as a text identifier of the item (instead of using the number of the item).

Arguments

  • int item - Item number in range from 0 to the total number of items.
  • const char * str - Item data to set.

const char * getItemData(int item)

Returns the data of a given item. The data can be used as a text identifier of the item (instead of using the number of the item).

Arguments

  • int item - Item number in range from 0 to the total number of items.

Return value

Item data.

void setItemEnabled(int item, int enabled)

Sets a value indicating if a given item is enabled (i.e. can be clicked).

Arguments

  • int item - Item number in range from 0 to the total number of items.
  • int enabled - Positive number to enable the item, 0 to disable it.

int isItemEnabled(int item)

Returns a value indicating if a given item can be clicked.

Arguments

  • int item - Item number in range from 0 to the total number of items.

Return value

Positive number if the item is enabled; otherwise, 0.

void setItemSelectable(int item, int selectable)

Sets a value indicating if a given item can be selected.

Arguments

  • int item - Item number in range from 0 to the total number of items.
  • int selectable - 1 to set the item as selectable; otherwise, 0.

int isItemSelectable(int item)

Returns a value indicating if a given item can be selected.

Arguments

  • int item - Item number in range from 0 to the total number of items.

Return value

Returns 1 if the item is selectable; otherwise, 0.

void setItemSeparator(int item, int separator)

Adds or removes a separator after a given item.

Arguments

  • int item - Item number in range from 0 to the total number of items.
  • int separator - Positive number to add a separator, 0 to remove it.

int isItemSeparator(int item)

Checks whether a separator is placed after the given item.

Arguments

  • int item - Item number in range from 0 to the total number of items.

Return value

Positive number if separator is placed; otherwise, 0.

void setItemSpace(int item, int space)

Sets a space after the given item.

Arguments

  • int item - Item number in range from 0 to the total number of items.
  • int space - Item space to set.

int getItemSpace(int item)

Returns the space after the given item.

Arguments

  • int item - Item number in range from 0 to the total number of items.

Return value

Item space.

void setItemText(int item, const char * str)

Sets a text for a given item.

Arguments

  • int item - Item number in range from 0 to the total number of items.
  • const char * str - Item text.

const char * getItemText(int item)

Returns the text of a given item in range from 0 to the total number of items.

Arguments

  • int item - Item number.

Return value

Item text.

void setItemTexture(int item, int texture)

Sets an icon for a given item.

Arguments

  • int item - Item number in range from 0 to the total number of items.
  • int texture - Zero-based ID of the icon (i.e. number of the icon in the icon texture).

int getItemTexture(int item)

Returns the icon of a given item.

Arguments

  • int item - Item number in range from 0 to the total number of items.

Return value

Zero-based ID of the icon (i.e. number of the icon in the icon texture).

void setItemToolTip(int item, const char * str)

Sets a tooltip for a given item.

Arguments

  • int item - Item number in range from 0 to the total number of items.
  • const char * str - Text of a tooltip to set.

const char * getItemToolTip(int item)

Returns the tooltip of a given item.

Arguments

  • int item - Item number in range from 0 to the total number of items.

Return value

Text of the item tooltip.

void setItemWidget(int item, const Ptr<Widget> & w)

Sets a menu widget for a given item.

Arguments

  • int item - Item number in range from 0 to the total number of menu items.
  • const Ptr<Widget> & w - Menu widget.

Ptr<Widget> getItemWidget(int item)

Returns the menu widget of a given item.

Arguments

  • int item - Item number in range from 0 to the total number of menu items.

Return value

Menu widget.

int getNumItems()

Returns the total number of items in the menu.

Return value

Number of items.

void setSpace(int x, int y)

Sets a space between menu items and between them and menu borders.

Arguments

  • int x - Horizontal space. If a negative value is provided, 0 will be used instead.
  • int y - Vertical space. If a negative value is provided, 0 will be used instead.

int getSpaceX()

Returns the horizontal space between menu items and between them and menu borders.

Return value

Horizontal space.

int getSpaceY()

Returns the vertical space between menu items and between them and menu borders.

Return value

Vertical space.

void setTexture(const char * texture)

Sets a texture with mini-icons to be used with items. The texture is a vertical strip of square icons.

Arguments

  • const char * texture - Path to a texture file.

const char * getTexture()

Returns the path to the texture with mini-icons, which are used with the list items. The texture is a vertical strip of square icons.

Return value

Path to the texture file.

int addItem(const char * str, int texture = -1)

Adds a new item with a given text and an icon.

Arguments

  • const char * str - Item text.
  • int texture - Zero-based ID of the icon (i.e. number of the icon in the icon texture). -1 means that an item has no icon.

Return value

Number of the added item.

void clear()

Removes all items from the menu.

void removeItem(int item)

Removes a given item from the menu.

Arguments

  • int item - Item number in range from 0 to the total number of items.

int type()

WidgetMenuBox type.

Return value

WidgetMenuBox type identifier.
Last update: 2017-07-03
Build: ()