This page has been translated automatically.
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1
注意! 这个版本的文档是过时的,因为它描述了一个较老的SDK版本!请切换到最新SDK版本的文档。
注意! 这个版本的文档描述了一个不再受支持的旧SDK版本!请升级到最新的SDK版本。

Unigine::WorldPortal Class

Interface for world portal handling. See also the UnigineScript analog.

To use this class, include the UnigineWorldPortal.h file.

Unigine::WorldPortal Class

Members


static int type ()

WorldPortal type.

Return value

WorldPortal type identifier.

static Ptr< WorldPortal > create (const NodePtr & node)

WorldPortal constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

static Ptr< WorldPortal > create (float width, float height)

WorldPortal constructor.

Arguments

  • float width - World portal width.
  • float height - World portal height.

virtual void setSize (float width, float height) const =0

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.

virtual float getWidth () const =0

Returns the current width of the world portal.

Return value

Current width of the portal.

virtual float getHeight () const =0

Returns the current height of the world portal.

Return value

Current height of the portal.

virtual int getNumWorldSectors () const =0

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

Return value

Number of sectors.

virtual Ptr< WorldSector > getWorldSector (int num) const =0

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.
Last update: 2017-07-03
Build: ()