This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
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::WorldPortal Class

Header: #include <UnigineWorlds.h>
Inherits: Node

A portal is an opening between two adjacent sectors, through which one sector can be partially seen if looking from another.

WorldPortal Class

Members


static WorldPortalPtr create ( float width, float height ) #

Constructor. Creates a new world portal with given dimensions.

Arguments

  • float width - Width of the new portal. If a negative value is provided, 0 is used instead.
  • float height - Height of the new portal. If a negative value is provided, 0 is used instead.

static Ptr<WorldPortal> cast ( const Ptr<Node> & node ) #

Casts a WorldPortal out of the Node instance.

Arguments

  • const Ptr<Node> & node - Pointer to Node.

Return value

Pointer to WorldPortal.

void setHeight ( float height ) #

Sets the height of the world portal.

Arguments

  • float height - Height, in units.

float getHeight ( ) #

Returns the current height of the world portal.

Return value

Current height of the portal.

void setWidth ( float width ) #

Sets the width of the world portal.

Arguments

  • float width - Width, in units.

float getWidth ( ) #

Returns the current width of the world portal.

Return value

Current width of the portal.

void setSize ( float width, float height ) #

Updates the current dimensions of the world portal.

Arguments

  • float width - World portal width. If a negative value is provided, 0 will be used instead.
  • float height - World portal height. If a negative value is provided, 0 will be used instead.

Ptr<WorldSector> getWorldSector ( int num ) #

Returns a specified world sector adjacent to the world portal.

Arguments

  • int num - Number of the sector in range from 0 to the total number of world sectors.

Return value

Specified sector.

int getNumWorldSectors ( ) #

Returns the number of world sectors connected with the world portal.

Return value

Number of sectors.

static int type ( ) #

Returns the type of the node.

Return value

World type identifier.
Last update: 2019-08-16
Build: ()