pawsObjectView Class Reference

This widget is used to view a mesh in it's own seperate world. More...

#include <pawsobjectview.h>

List of all members.

Public Member Functions
void	Clear ()
bool	ContinueLoad (bool onlyMesh=false)
	Continues an existing map load.
bool	CreateMap ()
	Creates a default map.
void	Draw ()
	Draws the widget and all of it's children.
void	Draw3D (iGraphics3D *)
void	EnableMouseControl (bool v)
csVector3 &	GetCameraPosModifier ()
psCharAppearance *	GetCharApp ()
unsigned int	GetID ()
	Gets the id of a widget.
iMeshWrapper *	GetObject ()
bool	LoadMap (const char *map, const char *sector)
	Loads a map to use as the backdrop.
void	LockCamera (csVector3 where, csVector3 at, bool mouseDownUnlock=false, bool mouseDownRotate=false)
bool	OnMouseDown (int button, int mod, int x, int y)
	Manage mouse down event to test for and apply window changes.
bool	OnMouseExit ()
	Called whenever the mouse leaves this widget.
bool	OnMouseUp (int button, int mod, int x, int y)
	Manage mouse up event.
void	OnResize ()
	Sets the new position of the close button.
	pawsObjectView ()
void	Rotate (int speed, float radians)
void	Rotate (float radians)
void	SetCameraPosModifier (csVector3 &mod)
void	SetCharApp (psCharAppearance *cApp)
void	SetID (unsigned int id)
	Assign this view an ID.
bool	Setup (iDocumentNode *node)
	Creates the room ( world ) for the mesh to be placed.
void	UnlockCamera ()
bool	View (const char *factName)
	View a mesh.
void	View (iMeshWrapper *wrapper)
	Make a copy of this mesh to view.
void	View (iMeshFactoryWrapper *wrapper)
	Use the specified mesh factory to create the mesh.
	~pawsObjectView ()

---

Detailed Description

This widget is used to view a mesh in it's own seperate world.

Definition at line 49 of file pawsobjectview.h.

---

Constructor & Destructor Documentation

pawsObjectView::pawsObjectView

(

)

pawsObjectView::~pawsObjectView

(

)

---

Member Function Documentation

void pawsObjectView::Clear

(

)

bool pawsObjectView::ContinueLoad

(

bool

onlyMesh = false

)

Continues an existing map load.

bool pawsObjectView::CreateMap

(

)

Creates a default map.

Creates a simple room to place object.

Returns:

True if the simple map is created.

void pawsObjectView::Draw

(

)

[virtual]

Draws the widget and all of it's children.

Remarks:

Uses clipping rect of it's parent to define drawing area. If the drawing area defined is empty it returns.

Reimplemented from pawsWidget.

void pawsObjectView::Draw3D

(

iGraphics3D *

)

[virtual]

Reimplemented from pawsWidget.

void pawsObjectView::EnableMouseControl

(

bool

v

)

[inline]

Definition at line 114 of file pawsobjectview.h.

csVector3& pawsObjectView::GetCameraPosModifier

(

)

[inline]

Definition at line 123 of file pawsobjectview.h.

psCharAppearance* pawsObjectView::GetCharApp

(

)

[inline]

Definition at line 145 of file pawsobjectview.h.

unsigned int pawsObjectView::GetID

(

)

[inline]

Gets the id of a widget.

Returns:

id The widget id.

Reimplemented from pawsWidget.

Definition at line 136 of file pawsobjectview.h.

iMeshWrapper* pawsObjectView::GetObject

(

)

[inline]

Definition at line 102 of file pawsobjectview.h.

bool pawsObjectView::LoadMap	(	const char *	map,
		const char *	sector
	)

Loads a map to use as the backdrop.

Parameters:

map	The full path name of the map to load
sector	The sector to use.

Returns:

True if the map was loaded correctly. False otherwise.

void pawsObjectView::LockCamera	(	csVector3	where,
		csVector3	at,
		bool	mouseDownUnlock = false,
		bool	mouseDownRotate = false
	)

bool pawsObjectView::OnMouseDown	(	int	button,
		int	modifiers,
		int	x,
		int	y
	)		[virtual]

Manage mouse down event to test for and apply window changes.

Parameters:

button	Type of button: 1 resizable or movable, 2 context menu or config window.
modifiers	Used with PAWS_CONSTRUCTION.
x	Used to test for resize.
y	Used to test for resize.

Returns:

bool TRUE if movable or resizable.

Remarks:

calls OnMouseDown on it's parent.

Reimplemented from pawsWidget.

Reimplemented in pawsInventoryDollView.

bool pawsObjectView::OnMouseExit

(

)

[virtual]

Called whenever the mouse leaves this widget.

Returns:

bool Parent's result or TRUE if no parent.

Reimplemented from pawsWidget.

bool pawsObjectView::OnMouseUp	(	int	button,
		int	modifiers,
		int	x,
		int	y
	)		[virtual]

Manage mouse up event.

Returns:

bool Parent's result or FALSE if no parent.

Remarks:

Acts recursively on it's parents.

Reimplemented from pawsWidget.

void pawsObjectView::OnResize

(

)

[virtual]

Sets the new position of the close button.

Reimplemented from pawsWidget.

void pawsObjectView::Rotate	(	int	speed,
		float	radians
	)

void pawsObjectView::Rotate

(

float

radians

)

void pawsObjectView::SetCameraPosModifier

(

csVector3 &

mod

)

[inline]

Definition at line 119 of file pawsobjectview.h.

void pawsObjectView::SetCharApp

(

psCharAppearance *

cApp

)

[inline]

Definition at line 141 of file pawsobjectview.h.

void pawsObjectView::SetID

(

unsigned int

id

)

[inline]

Assign this view an ID.

Definition at line 132 of file pawsobjectview.h.

bool pawsObjectView::Setup

(

iDocumentNode *

node

)

[virtual]

Creates the room ( world ) for the mesh to be placed.

Reimplemented from pawsWidget.

void pawsObjectView::UnlockCamera

(

)

bool pawsObjectView::View

(

const char *

factName

)

View a mesh.

Parameters:

factName

The name of the factory to use.

void pawsObjectView::View

(

iMeshWrapper *

wrapper

)

Make a copy of this mesh to view.

Parameters:

wrapper

Will use the factory of this mesh to create a copy of it.

void pawsObjectView::View

(

iMeshFactoryWrapper *

wrapper

)

Use the specified mesh factory to create the mesh.

Parameters:

wrapper

Will use this factory to create the mesh.

---

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

• common/paws/pawsobjectview.h