Portal Class Reference
[Miscellaneous]

An object that provides a "window" into a zone, allowing a viewer to see what's rendered in the zone. More...

Inheritance diagram for Portal:

[legend]

List of all members.

Public Member Functions
bool	isExteriorPortal ()
	Test whether the portal connects interior zones to the outdoor zone.
bool	isInteriorPortal ()
	Test whether the portal connects interior zones only.
Public Attributes
Zoning
bool	backSidePassable
	Whether one can view through the back-side of the portal.
bool	frontSidePassable
	Whether one can view through the front-side of the portal.
Static Public Attributes
static bool	isRenderable
	Disables rendering of all instances of this type.
static bool	isSelectable
	Disables selection of all instances of this type.

---

Detailed Description

An object that provides a "window" into a zone, allowing a viewer to see what's rendered in the zone.

This is one of two objects used by the manual culling system Torque 3D provides, the other being Zone. When a Zone is placed in a level, all rendering within the zone is hidden from view when the camera is outside it. When inside, all rendering outside the zone is hidden. This is an excellent way to optimize large levels and complex geometry.

You can attach a Portal a zone. This allows you to view what is rendered in the Zone (or what is rendered outside if you are in the zone), like a window. The larger the Portal, the more you can see through a zone.

Example:

// Example declaration of a Portal
new Portal( PortalToTestZone )
{
   position = "12.8467 -4.02246 14.8017";
    rotation = "0 0 -1 97.5085";
    scale = "1 0.25 1";
    canSave = "1";
    canSaveDynamicFields = "1";
};

See also:

Zone

---

Member Function Documentation

bool Portal::isExteriorPortal

(

)

Test whether the portal connects interior zones to the outdoor zone.

Returns:

True if the portal is an exterior portal.

bool Portal::isInteriorPortal

(

)

Test whether the portal connects interior zones only.

Returns:

True if the portal is an interior portal.

---

Member Data Documentation

bool Portal::backSidePassable

Whether one can view through the back-side of the portal.

bool Portal::frontSidePassable

Whether one can view through the front-side of the portal.

bool Portal::isRenderable [static]

Disables rendering of all instances of this type.

Reimplemented from Zone.

bool Portal::isSelectable [static]

Disables selection of all instances of this type.

Reimplemented from Zone.