From Moviesandbox

Revision as of 14:37, 18 March 2009 (edit) Fiezi (Talk | contribs) (New page: {{subst:Template:ClassTemplate}}) ← Previous diff		Current revision (19:05, 18 March 2009) (edit) (undo) Fiezi (Talk | contribs)
(One intermediate revision not shown.)
Line 1:		Line 1:
-	<h1>class MyClass</h1>	+	<h1>class Controller</h1>
-	''derived from: [[ParentClass]]''	+	''derived from: [[Actor]]''
-	Description of what the class does	+	The Controller allows the User to control certain Actors with mouse and keyboard through states. It also controls when to start or to stop a scene and manages the node trees in a scene. The Controller can "possess" actors and will use the possessed actors' position and rotation as the viewport camera.
	<h3>Members:</h3>		<h3>Members:</h3>
-	<h4>MemberType * memberName</h4>	+	<h4>static bool bRunning</h4>
		+	Static variable that determines is the scene is running or not. Can be accessed from everywhere.
		+
		+	<h4>static vector <[[Node]] *> nodeList</h4>
		+	A list of all the nodes in the scene.
		+
		+	<h4>static vector<[[Node]] *> nodeTree</h4>
		+	A list of all the node Trees starting Nodes in the scene. Node tree starting nodes (Root Nodes) are [[RootNode]] and [[KeyInputNode]].
		+
		+	<h4>[[Actor]] *controlledActor</h4>
		+	The [[Actor]] this controller is currently controlling - also serves as the viewLocation for the [[Renderer]].
		+
		+	<h4>[[NavButton]] *navBtn</h4>
		+	A reference to the navigation button, used for view Rotation.
		+
		+	<h4>Vector3f lookPoint</h4>
		+	A point that is 1 unit away from the controlledactor's location in the direction of the controlledactor's rotation. Is used for viewport.
		+
		+	<h4>int state</h4>
		+	Can be either MOVECURSORSTATE or MOVECAMERASTATE, defines if we change the viewpoint with mouse/keyboard or just move the cursor around.
		+
		+	<h4>int moveMode</h4>
		+	Can be FLYINGCAMERA or WALKINGCAMERA. Currently only supports FLYINGCAMERA.
		+
		+	<h4>[[Actor]] * cameraActor</h4>
		+
		+	The viewport position reference. Also the Actor that gets moved when in MOVECAMERASTATE.
	<h3>Functions:</h3>		<h3>Functions:</h3>
-	<h4>Function definition</h4>	+	<h4>void update(double deltaTime)</h4>
		+	''called from:'' Renderer::update() ''(as part of ActorList)''
		+
		+	checks the '''state''' variable and calls processMove if we're in MOVECAMERASTATE. Also calls updateNodes() if the scene is running (bRunning is true).
		+
		+	<h4>void processMove (double deltaTime)</h4>
		+	''called from:'' Controller::update(double deltaTime)
		+
		+	This function takes mouse movement and keyPresses from [[NavButton|NavBtn]] and [[Input]] and changes the controlledActor's location, rotation and calculates the lookPoint location.
		+
		+	<h4>void confineMouse()</h4>
		+
		+	<h4>void switchMode()</h4>
		+
		+	<h4>void start()</h4>
		+
		+	<h4>void stop()</h4>
		+
-	See also: [[Controller]]	+	See also: [[Input]], [[Actor]]
	[[Category:Code Index]]		[[Category:Code Index]]

---

Current revision

Contents 1 class Controller 1.1 Members: 1.1.1 static bool bRunning 1.1.2 static vector <Node *> nodeList 1.1.3 static vector<Node *> nodeTree 1.1.4 Actor *controlledActor 1.1.5 NavButton *navBtn 1.1.6 Vector3f lookPoint 1.1.7 int state 1.1.8 int moveMode 1.1.9 Actor * cameraActor 1.2 Functions: 1.2.1 void update(double deltaTime) 1.2.2 void processMove (double deltaTime) 1.2.3 void confineMouse() 1.2.4 void switchMode() 1.2.5 void start() 1.2.6 void stop()

[edit] class Controller

derived from: Actor

The Controller allows the User to control certain Actors with mouse and keyboard through states. It also controls when to start or to stop a scene and manages the node trees in a scene. The Controller can "possess" actors and will use the possessed actors' position and rotation as the viewport camera.

[edit] Members:

[edit] static bool bRunning

Static variable that determines is the scene is running or not. Can be accessed from everywhere.

[edit] static vector <Node *> nodeList

A list of all the nodes in the scene.

[edit] static vector<Node *> nodeTree

A list of all the node Trees starting Nodes in the scene. Node tree starting nodes (Root Nodes) are RootNode and KeyInputNode.

[edit] Actor *controlledActor

The Actor this controller is currently controlling - also serves as the viewLocation for the Renderer.

[edit] NavButton *navBtn

A reference to the navigation button, used for view Rotation.

[edit] Vector3f lookPoint

A point that is 1 unit away from the controlledactor's location in the direction of the controlledactor's rotation. Is used for viewport.

[edit] int state

Can be either MOVECURSORSTATE or MOVECAMERASTATE, defines if we change the viewpoint with mouse/keyboard or just move the cursor around.

[edit] int moveMode

Can be FLYINGCAMERA or WALKINGCAMERA. Currently only supports FLYINGCAMERA.

[edit] Actor * cameraActor

The viewport position reference. Also the Actor that gets moved when in MOVECAMERASTATE.

[edit] Functions:

[edit] void update(double deltaTime)

called from: Renderer::update() (as part of ActorList)

checks the state variable and calls processMove if we're in MOVECAMERASTATE. Also calls updateNodes() if the scene is running (bRunning is true).

[edit] void processMove (double deltaTime)

called from: Controller::update(double deltaTime)

This function takes mouse movement and keyPresses from NavBtn and Input and changes the controlledActor's location, rotation and calculates the lookPoint location.

[edit] void confineMouse()

[edit] void switchMode()

[edit] void start()

[edit] void stop()

See also: Input, Actor