Unigine::WorldPortal Class

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 will be used instead.
• float height - Height of the new portal. If a negative value is provided, 0 will be used instead.

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.

float getHeight()

Returns the current height of the world portal.

Return value

Current height of the portal.

int getNumWorldSectors()

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

Return value

Number of sectors.

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.

float getWidth()

Returns the current width of the world portal.

Return value

Current width of the portal.

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 type()

Returns the type of the node.

Return value

World type identifier.