class PortalObject

Defined in: C4Portals.h

The PortalObject class encapsulates data for a portal.

Definition

class PortalObject : public Object

Member Functions

`PortalObject::GetPortalType`	Returns the portal type.
`PortalObject::GetPortalFlags`	Returns the portal flags.
`PortalObject::SetPortalFlags`	Sets the portal flags.
`PortalObject::GetVertexCount`	Returns the number of vertices defining the boundary of the portal.
`PortalObject::SetVertexCount`	Sets the number of vertices defining the boundary of the portal.
`PortalObject::GetVertexArray`	Returns the object-space vertex array defining the boundary of the portal.
`PortalObject::SetPortalSize`	Configures a portal to be a rectangle of given size.

Constructor

PortalObject(PortalType type);

PortalObject(PortalType type, const Vector2D& size);

The constructors have protected access. The PortalObject 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.
`size`	The width and height of a rectangular portal.

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

Object A PortalObject is an object that can be shared by multiple portal nodes.