class Portal

Defined in: C4Portals.h

The Portal class represents a portal node in a world.

Definition

class Portal : public Node, public ListElement<Portal>

Member Functions

`Portal::GetPortalType`	Returns the portal type.
`Portal::GetWorldPlane`	Returns the world-space plane containing the portal.
`Portal::GetWorldVertexArray`	Returns the world-space vertex array defining the boundary of the portal.
`Portal::GetZoneConnector`	Returns the zone to which the portal is connected.
`Portal::SetZoneConnector`	Sets the zone to which the portal is connected.

Constructor

Portal(PortalType type);

The constructor has protected access. The Portal class can only exist as the base class for a more specific type of portal.

Parameters

type The portal type. See below for a list of possible types.

Description

`kPortalDirect`	An ordinary portal that leads from one zone to another.
`kPortalRemote`	A portal having a remote transform. This is used for mirrors and portals through which remote areas of the world can be seen.
`kPortalCamera`	A special portal used internally for camera widgets in panel effects.
`kPortalOcclusion`	An occluder, or antiportal, that blocks objects behind it from the perspective of the camera.

Base Classes

`Node`	A `Portal` node is a scene graph node.
`ListElement<Portal>`	Each zone has a list of portals that lead out of the zone.