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
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::WorldSector Class

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

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

Unigine::WorldSector Class

Members


static int type ()

WorldSector type.

Return value

WorldSector type identifier.

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

WorldSector constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

static Ptr< WorldSector > create (const vec3 & size)

WorldSector constructor.

Arguments

  • const vec3 & size - World sector size.

virtual Ptr< Node > getNode () const =0

Returns a node pointer.

Return value

Node pointer.

virtual void setSize (const vec3 & size) const =0

Updates the current dimensions of the world sector. The minimum value is vec3(0,0,0).

Arguments

  • const vec3 & size - Dimensions of the world sector.

virtual vec3 getSize () const =0

Returns the current dimensions of the world sector. The minimum value is vec3(0,0,0).

Return value

Current dimensions.

virtual int getNumNodes () const =0

Returns the number of nodes contained in the world sector.

Return value

Number of nodes.

virtual NodePtr getNode (int num) const =0

Returns a specified node contained in the world sector.

Arguments

  • int num - Number of the node in range from 0 to the total number of nodes.

Return value

Specified node.

virtual int getNumWorldPortals () const =0

Returns the number of world portals adjacent to the world sector.

Return value

Number of portals.

virtual Ptr< WorldPortal > getWorldPortal (int num) const =0

Returns a specified world portal adjacent to the world sector.

Arguments

  • int num - Number of the portal in range from 0 to the total number of portals.

Return value

Specified portal.
Last update: 2017-07-03
Build: ()