PLScene::SNCellPortal Class Reference

Cell-portal scene node. More...

#include <SNCellPortal.h>

Inheritance diagram for PLScene::SNCellPortal:

List of all members.

Public Types
enum	EFlags { NoSeeThrough = 1<<10, NoPassThrough = 1<<11 }
	Scene node flags (SceneNode flags extension) More...
Public Member Functions
PLS_API	SNCellPortal ()
	Default constructor.
virtual PLS_API	~SNCellPortal ()
	Destructor.
PLS_API SCCell *	GetTargetCellInstance ()
	Returns the cell the cell-portal links to.
PLS_API const PLMath::Matrix3x4 &	GetWarpMatrix ()
	Returns the warp matrix.

---

Detailed Description

Cell-portal scene node.

Remarks:

A cell-portal allows the viewer to look from one into another cell.

---

Member Enumeration Documentation

enum PLScene::SNCellPortal::EFlags

Scene node flags (SceneNode flags extension)

Enumerator:

NoSeeThrough	It's not possible to 'see through' this cell-portal into the target cell (example usage: closed door)
NoPassThrough	It's not possible to 'pass through' this cell-portal into the target cell (example usage: window)

Reimplemented from PLScene::SceneNode.

---

Constructor & Destructor Documentation

PLS_API PLScene::SNCellPortal::SNCellPortal

(

)

Default constructor.

virtual PLS_API PLScene::SNCellPortal::~SNCellPortal

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLS_API SCCell* PLScene::SNCellPortal::GetTargetCellInstance

(

)

Returns the cell the cell-portal links to.

Returns:

The cell the cell-portal links to, a null pointer on error (maybe there's no node with the cell name or this node is no cell)

PLS_API const PLMath::Matrix3x4& PLScene::SNCellPortal::GetWarpMatrix

(

)

Returns the warp matrix.

Returns:

The warp matrix

Remarks:

The warp matrix transforms from this cell space into target cell space.

Note:

• Is updated automatically

Reimplemented from PLScene::SNPortal.

---

The documentation for this class was generated from the following file:

• SNCellPortal.h