Public API Reference

                 

---

iPortalContainer Struct Reference
[Crystal Space 3D Engine]

A container for portals. More...

#include <portalcontainer.h>

Inheritance diagram for iPortalContainer:

List of all members.

Public Methods
virtual int	GetPortalCount () const=0
	Get the number of portals in this contain.
virtual iPortal *	GetPortal (int idx) const=0
	Get a specific portal.
virtual iPortal *	CreatePortal (csVector3 *vertices, int num)=0
	Create a new portal.
virtual void	RemovePortal (iPortal *portal)=0
	Remove a portal.
virtual void	Draw (iRenderView *rview)=0
	Render the portal container.

---

Detailed Description

A container for portals.

Main creators of instances implementing this interface:

• iEngine::CreatePortalContainer()
• iEngine::CreatePortal()

Main ways to get pointers to this interface:

• SCF_QUERY_INTERFACE() on iMeshObject from a portal container mesh.

Main users of this interface:

• iEngine

Definition at line 52 of file portalcontainer.h.

---

Member Function Documentation

virtual iPortal* iPortalContainer::CreatePortal (  csVector3 *    vertices, int    num )  [pure virtual]

Create a new portal.

virtual void iPortalContainer::Draw (  iRenderView *    rview )  [pure virtual]

Render the portal container.

virtual iPortal* iPortalContainer::GetPortal (  int    idx )  const [pure virtual]

Get a specific portal.

virtual int iPortalContainer::GetPortalCount (    )  [pure virtual]

Get the number of portals in this contain.

virtual void iPortalContainer::RemovePortal (  iPortal *    portal )  [pure virtual]

Remove a portal.

---

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

• iengine/portalcontainer.h

---