Editor Camera Script External Code - Revision history

Merlyn: /* CameraObject class */

2017-11-19T04:30:52Z

CameraObject class

← Older revision		Revision as of 21:30, 18 November 2017
Line 20:		Line 20:
	It also gives access to a quaternion representing the orientation of the camera, instead of <code>Camera</code>'s euler angle access functions.		It also gives access to a quaternion representing the orientation of the camera, instead of <code>Camera</code>'s euler angle access functions.

	'''Note''': It is recommended to also set all these properties/call these functions on the '''<code>camera</code>''' object to match this camera controller in the camera script '''<code>Update</code>''' function:		'''Note''': It is recommended to also set all these properties/call these functions on the '''<code>camera</code>''' object to match this camera controller in the editor camera script '''<code>Update</code>''' function:

	* <code>camera.SetYRotation</code>, <code>camera.SetXRotation</code>, <code>camera.SetZRotation</code>		* <code>camera.SetYRotation</code>, <code>camera.SetXRotation</code>, <code>camera.SetZRotation</code>

Merlyn: moved Camera Script External Code to Editor Camera Script External Code

2017-11-19T04:25:27Z

moved Camera Script External Code to Editor Camera Script External Code

← Older revision	Revision as of 21:25, 18 November 2017
(No difference)

Merlyn at 04:09, 19 November 2017

2017-11-19T04:09:32Z

← Older revision		Revision as of 21:09, 18 November 2017
Line 5:		Line 5:
	To see a list of external code that is available to all scripts, please see this page - [[Common Script External Code]]		To see a list of external code that is available to all scripts, please see this page - [[Common Script External Code]]

	This page is manually updated, so may be slightly out of date from time to time~~. '''TODO''': Add camera script page and link its docs section here, similar to the [[LevelScripts#Documentation]] page section~~.		This page is manually updated, so may be slightly out of date from time to time.

	== Global Variables ==		== Global Variables ==

Merlyn: /* CameraObject class */

2017-11-19T03:31:35Z

CameraObject class

← Older revision		Revision as of 20:31, 18 November 2017
Line 20:		Line 20:
	It also gives access to a quaternion representing the orientation of the camera, instead of <code>Camera</code>'s euler angle access functions.		It also gives access to a quaternion representing the orientation of the camera, instead of <code>Camera</code>'s euler angle access functions.

	'''Note''': It is recommended to also set all these properties on the '''<code>camera</code>''' object to match this camera controller in the camera script '''<code>Update</code>''' function:		'''Note''': It is recommended to also set all these properties/call these functions on the '''<code>camera</code>''' object to match this camera controller in the camera script '''<code>Update</code>''' function:

	* <code>camera.SetYRotation</code>, <code>camera.SetXRotation</code>, <code>camera.SetZRotation</code>		* <code>camera.SetYRotation</code>, <code>camera.SetXRotation</code>, <code>camera.SetZRotation</code>

Merlyn: /* CameraObject class */

2017-11-19T03:30:59Z

CameraObject class

← Older revision		Revision as of 20:30, 18 November 2017
Line 19:		Line 19:

	It also gives access to a quaternion representing the orientation of the camera, instead of <code>Camera</code>'s euler angle access functions.		It also gives access to a quaternion representing the orientation of the camera, instead of <code>Camera</code>'s euler angle access functions.

			'''Note''': It is recommended to also set all these properties on the '''<code>camera</code>''' object to match this camera controller in the camera script '''<code>Update</code>''' function:

			* <code>camera.SetYRotation</code>, <code>camera.SetXRotation</code>, <code>camera.SetZRotation</code>
			* <code>camera.SetPos</code>
			* <code>camera.SetDistance</code>
			* <code>camera.SetVelocity</code>
			* <code>camera.SetFOV</code>
			* <code>camera.SetDOF</code>
			* <code>camera.CalcFacing</code>, <code>camera.CalcUp</code>

	'''Properties'''		'''Properties'''

Merlyn: /* CameraObject class */

2017-11-19T03:25:37Z

CameraObject class

Merlyn: /* CameraObject class */

2017-11-19T03:24:47Z

CameraObject class

← Older revision		Revision as of 20:24, 18 November 2017
Line 21:		Line 21:

	'''Properties'''		'''Properties'''
	<pre style="white-space: pre-wrap;">vec3 velocity; // The current velocity of the editor camera controller. Note: always call camera.SetVelocity in Update to set the actual camera velocity to match		<pre style="white-space: pre-wrap;">vec3 velocity;
			// The current velocity of the editor camera controller. Note: always call camera.SetVelocity in Update to set the actual camera velocity to match</pre>
	bool controlled; // Whether the editor camera controller is currently being controlled by a player		<pre style="white-space: pre-wrap;">bool controlled; // Whether the editor camera controller is currently being controlled by a player</pre>
			<pre style="white-space: pre-wrap;">bool frozen; // If the script should ignore all controller input. The engine doesn't currently use this at all</pre>
	bool frozen; // If the script should ignore all controller input. The engine doesn't currently use this at all		<pre style="white-space: pre-wrap;">bool ignore_mouse_input;
			// If the script should ignore mouse input. Engine sets this when editor is doing selection, transformations</pre>
	bool ignore_mouse_input; // If the script should ignore mouse input. Engine sets this when editor is doing selection, transformations		<pre style="white-space: pre-wrap;">bool has_position_initialized;
			// Initialized to false when a level loads. Useful for teleporting the camera to the first controlled movement object</pre>
	bool has_position_initialized; // Initialized to false when a level loads. Useful for teleporting the camera to the first controlled movement object</pre>

	'''Methods'''		'''Methods'''
	<pre style="white-space: pre-wrap;">const quaternion& GetRotation(); // Get the current direction of the editor camera controller		<pre style="white-space: pre-wrap;">const quaternion& GetRotation(); // Get the current direction of the editor camera controller</pre>
			<pre style="white-space: pre-wrap;">void SetRotation(const quaternion &in quat);
	void SetRotation(const quaternion &in quat);		// Set the current direction of the editor camera controller. Note: always call camera.SetXRotation, etc, in Update to set the actual camera rotation to match</pre>
	// Set the current direction of the editor camera controller. Note: always call camera.SetXRotation, etc, in Update to set the actual camera rotation to match		<pre style="white-space: pre-wrap;">const vec3& GetTranslation(); // Gets the current position of the editor camera controller</pre>
			<pre style="white-space: pre-wrap;">void SetTranslation(const vec3 &in vec);
	const vec3& GetTranslation(); // Gets the current position of the editor camera controller

	void SetTranslation(const vec3 &in vec);
	// Sets the current position of the editor camera controller. Note: always call camera.SetPos in Update to move the actual camera to the same spot</pre>		// Sets the current position of the editor camera controller. Note: always call camera.SetPos in Update to move the actual camera to the same spot</pre>

Merlyn: /* CameraObject class */

2017-11-19T03:23:01Z

CameraObject class

Merlyn: /* CameraObject class */

2017-11-19T03:22:21Z

CameraObject class

← Older revision		Revision as of 20:22, 18 November 2017
Line 29:		Line 29:
	'''Methods'''		'''Methods'''
	<pre style="white-space: pre-wrap;">const quaternion& GetRotation(); // Get the current direction of the editor camera controller		<pre style="white-space: pre-wrap;">const quaternion& GetRotation(); // Get the current direction of the editor camera controller
	void SetRotation(const quaternion &in quat); // Set the current direction of the editor camera controller. Note: always call camera.SetXRotation, etc, in ~~update~~ to set the actual camera rotation to match		void SetRotation(const quaternion &in quat);
			// Set the current direction of the editor camera controller. Note: always call camera.SetXRotation, etc, in Update to set the actual camera rotation to match
	const vec3& GetTranslation(); // Gets the current position of the editor camera controller		const vec3& GetTranslation(); // Gets the current position of the editor camera controller
	void SetTranslation(const vec3 &in vec); // Sets the current position of the editor camera controller. Note: always call camera.SetPos in Update to move the actual camera to the same spot</pre>		void SetTranslation(const vec3 &in vec);
			// Sets the current position of the editor camera controller. Note: always call camera.SetPos in Update to move the actual camera to the same spot</pre>

	'''Related Global Variables'''		'''Related Global Variables'''
	<pre style="white-space: pre-wrap;">CameraObject co; // The global instance of this editor camera controller class</pre>		<pre style="white-space: pre-wrap;">CameraObject co; // The global instance of this editor camera controller class</pre>
	<pre style="white-space: pre-wrap;">Camera camera; // The global instance of an object for controlling the actual camera itself</pre>		<pre style="white-space: pre-wrap;">Camera camera; // The global instance of an object for controlling the actual camera itself</pre>

Merlyn: /* CameraObject class */

2017-11-19T03:21:23Z

CameraObject class

← Older revision		Revision as of 20:21, 18 November 2017
Line 29:		Line 29:
	'''Methods'''		'''Methods'''
	<pre style="white-space: pre-wrap;">const quaternion& GetRotation(); // Get the current direction of the editor camera controller		<pre style="white-space: pre-wrap;">const quaternion& GetRotation(); // Get the current direction of the editor camera controller
	void SetRotation(const quaternion &in quat); // Set the current direction of the editor camera controller		void SetRotation(const quaternion &in quat); // Set the current direction of the editor camera controller. Note: always call camera.SetXRotation, etc, in update to set the actual camera rotation to match
	const vec3& GetTranslation(); // Gets the current position of the editor camera controller		const vec3& GetTranslation(); // Gets the current position of the editor camera controller
	void SetTranslation(const vec3 &in vec); // Sets the current position of the editor camera controller. Note: always call camera.SetPos in Update to move the actual camera to the same spot</pre>		void SetTranslation(const vec3 &in vec); // Sets the current position of the editor camera controller. Note: always call camera.SetPos in Update to move the actual camera to the same spot</pre>

← Older revision		Revision as of 20:25, 18 November 2017
Line 22:		Line 22:
	'''Properties'''		'''Properties'''
	<pre style="white-space: pre-wrap;">vec3 velocity;		<pre style="white-space: pre-wrap;">vec3 velocity;
	// The current velocity of the editor camera controller. Note: always call camera.SetVelocity in Update to set the actual camera velocity to match</pre>		// The current velocity of the editor camera controller.
			// Note: always call camera.SetVelocity in Update to set the actual camera velocity to match</pre>
	<pre style="white-space: pre-wrap;">bool controlled; // Whether the editor camera controller is currently being controlled by a player</pre>		<pre style="white-space: pre-wrap;">bool controlled; // Whether the editor camera controller is currently being controlled by a player</pre>
	<pre style="white-space: pre-wrap;">bool frozen; // If the script should ignore all controller input. The engine doesn't currently use this at all</pre>		<pre style="white-space: pre-wrap;">bool frozen; // If the script should ignore all controller input. The engine doesn't currently use this at all</pre>
Line 33:		Line 34:
	<pre style="white-space: pre-wrap;">const quaternion& GetRotation(); // Get the current direction of the editor camera controller</pre>		<pre style="white-space: pre-wrap;">const quaternion& GetRotation(); // Get the current direction of the editor camera controller</pre>
	<pre style="white-space: pre-wrap;">void SetRotation(const quaternion &in quat);		<pre style="white-space: pre-wrap;">void SetRotation(const quaternion &in quat);
	// Set the current direction of the editor camera controller. Note: always call camera.SetXRotation, etc, in Update to set the actual camera rotation to match</pre>		// Set the current direction of the editor camera controller.
			// Note: always call camera.SetXRotation, etc, in Update to set the actual camera rotation to match</pre>
	<pre style="white-space: pre-wrap;">const vec3& GetTranslation(); // Gets the current position of the editor camera controller</pre>		<pre style="white-space: pre-wrap;">const vec3& GetTranslation(); // Gets the current position of the editor camera controller</pre>
	<pre style="white-space: pre-wrap;">void SetTranslation(const vec3 &in vec);		<pre style="white-space: pre-wrap;">void SetTranslation(const vec3 &in vec);
	// Sets the current position of the editor camera controller. Note: always call camera.SetPos in Update to move the actual camera to the same spot</pre>		// Sets the current position of the editor camera controller.
			// Note: always call camera.SetPos in Update to move the actual camera to the same spot</pre>

	'''Related Global Variables'''		'''Related Global Variables'''
	<pre style="white-space: pre-wrap;">CameraObject co; // The global instance of this editor camera controller class</pre>		<pre style="white-space: pre-wrap;">CameraObject co; // The global instance of this editor camera controller class</pre>
	<pre style="white-space: pre-wrap;">Camera camera; // The global instance of an object for controlling the actual camera itself</pre>		<pre style="white-space: pre-wrap;">Camera camera; // The global instance of an object for controlling the actual camera itself</pre>

← Older revision		Revision as of 20:23, 18 November 2017
Line 22:		Line 22:
	'''Properties'''		'''Properties'''
	<pre style="white-space: pre-wrap;">vec3 velocity; // The current velocity of the editor camera controller. Note: always call camera.SetVelocity in Update to set the actual camera velocity to match		<pre style="white-space: pre-wrap;">vec3 velocity; // The current velocity of the editor camera controller. Note: always call camera.SetVelocity in Update to set the actual camera velocity to match

	bool controlled; // Whether the editor camera controller is currently being controlled by a player		bool controlled; // Whether the editor camera controller is currently being controlled by a player

	bool frozen; // If the script should ignore all controller input. The engine doesn't currently use this at all		bool frozen; // If the script should ignore all controller input. The engine doesn't currently use this at all

	bool ignore_mouse_input; // If the script should ignore mouse input. Engine sets this when editor is doing selection, transformations		bool ignore_mouse_input; // If the script should ignore mouse input. Engine sets this when editor is doing selection, transformations

	bool has_position_initialized; // Initialized to false when a level loads. Useful for teleporting the camera to the first controlled movement object</pre>		bool has_position_initialized; // Initialized to false when a level loads. Useful for teleporting the camera to the first controlled movement object</pre>

	'''Methods'''		'''Methods'''
	<pre style="white-space: pre-wrap;">const quaternion& GetRotation(); // Get the current direction of the editor camera controller		<pre style="white-space: pre-wrap;">const quaternion& GetRotation(); // Get the current direction of the editor camera controller

	void SetRotation(const quaternion &in quat);		void SetRotation(const quaternion &in quat);
	// Set the current direction of the editor camera controller. Note: always call camera.SetXRotation, etc, in Update to set the actual camera rotation to match		// Set the current direction of the editor camera controller. Note: always call camera.SetXRotation, etc, in Update to set the actual camera rotation to match

	const vec3& GetTranslation(); // Gets the current position of the editor camera controller		const vec3& GetTranslation(); // Gets the current position of the editor camera controller

	void SetTranslation(const vec3 &in vec);		void SetTranslation(const vec3 &in vec);
	// Sets the current position of the editor camera controller. Note: always call camera.SetPos in Update to move the actual camera to the same spot</pre>		// Sets the current position of the editor camera controller. Note: always call camera.SetPos in Update to move the actual camera to the same spot</pre>