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
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)