note
	description: "A 3d object for the 3d audio library."
	author: "Louis Marchand"
	date: "Tue, 07 Apr 2015 01:15:20 +0000"
	revision: "2.0"

deferred class 
	AUDIO_3D_OBJECT

feature {NONE} -- Initialization

	default_create
			-- Process instances of classes with no creation clause.
			-- (Default: do nothing.)
			-- (from ANY)
		do
		end
	
feature -- Access

	generating_type: TYPE [detachable AUDIO_3D_OBJECT]
			-- Type of current object
			-- (type of which it is a direct instance)
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			generating_type_not_void: Result /= Void
		end

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			generator_not_void: Result /= Void
			generator_not_empty: not Result.is_empty
		end

	has_error: BOOLEAN
			-- Is the library has generate an error
			-- (from GAME_ERROR_MANAGER)

	last_error: READABLE_STRING_GENERAL
			-- The last error generate by the library
			-- (from AUDIO_OPENAL_ERROR_MANAGER)
		do
			if is_manual_error then
				Result := Precursor {GAME_ERROR_MANAGER}
			elseif last_al_error_code /= {AUDIO_EXTERNAL}.al_no_error then
				if last_al_error_code = {AUDIO_EXTERNAL}.al_invalid_enum then
					Result := "An invalid enum value was passed to an OpenAL function."
				elseif last_al_error_code = {AUDIO_EXTERNAL}.al_invalid_value then
					Result := "An invalid value was passed to an OpenAL function."
				elseif last_al_error_code = {AUDIO_EXTERNAL}.al_invalid_operation then
					Result := "The requested operation is not valid."
				elseif last_al_error_code = {AUDIO_EXTERNAL}.al_invalid_name then
					Result := "A bad name (ID) was passed to an OpenAL function."
				elseif last_al_error_code = {AUDIO_EXTERNAL}.al_out_of_memory then
					Result := "The requested operation resulted in OpenAL running out of memory."
				else
					Result := "Unmanaged OpenAL error."
				end
			elseif last_alc_error_code /= {AUDIO_EXTERNAL}.alc_no_error then
				if last_alc_error_code = {AUDIO_EXTERNAL}.alc_invalid_value then
					Result := "An invalid value was passed to an OpenAL context function."
				elseif last_alc_error_code = {AUDIO_EXTERNAL}.alc_invalid_device then
					Result := "The device is not valid."
				elseif last_alc_error_code = {AUDIO_EXTERNAL}.alc_invalid_context then
					Result := "The context is not valid."
				elseif last_alc_error_code = {AUDIO_EXTERNAL}.alc_invalid_enum then
					Result := "Invalid enum parameter passed to an ALC call."
				elseif last_alc_error_code = {AUDIO_EXTERNAL}.alc_out_of_memory then
					Result := "Out of memory."
				else
					Result := "Unmanaged OpenAL context error."
				end
			else
				Result := "No error."
			end
		end

	position: TUPLE [x: REAL_32; y: REAL_32; z: REAL_32]
			-- Get the object position in a 3D environment.
		do
			Result := params_3_float ({AUDIO_EXTERNAL}.al_position)
		end

	set_position (a_x, a_y, a_z: REAL_32)
			-- Set the object position in a 3D environment.
		require -- from  GAME_3D_OBJECT
			True
		do
			set_params_3_float ({AUDIO_EXTERNAL}.al_position, a_x, a_y, a_z)
		ensure -- from GAME_3D_OBJECT
			is_assign: attached position as la_position implies (la_position.x ~ a_x and la_position.y ~ a_y and la_position.z ~ a_z)
		ensure then
			is_assign: not has_error implies (attached position as la_position implies (la_position.x ~ a_x and la_position.y ~ a_y and la_position.z ~ a_z))
		end

	set_velocity (a_x, a_y, a_z: REAL_32)
			-- Set the object velocity (deplacement) in a 3D environment.
		do
			set_params_3_float ({AUDIO_EXTERNAL}.al_velocity, a_x, a_y, a_z)
		ensure then
			is_assign: not has_error implies (attached velocity as la_velocity implies (la_velocity.x ~ a_x and la_velocity.y ~ a_y and la_velocity.z ~ a_z))
		end

	set_x (a_x: REAL_32)
			-- Assign the x coordinate of the position
			-- (from GAME_3D_OBJECT)
		do
			set_position (a_x, y, z)
		ensure -- from GAME_3D_OBJECT
			is_assign: x ~ a_x
		end

	set_y (a_y: REAL_32)
			-- Assign the y coordinate of the position
			-- (from GAME_3D_OBJECT)
		do
			set_position (x, a_y, z)
		ensure -- from GAME_3D_OBJECT
			is_assign: y ~ a_y
		end

	set_z (a_z: REAL_32)
			-- Assign the z coordinate of the position
			-- (from GAME_3D_OBJECT)
		do
			set_position (x, y, a_z)
		ensure -- from GAME_3D_OBJECT
			is_assign: z ~ a_z
		end

	velocity: TUPLE [x: REAL_32; y: REAL_32; z: REAL_32]
			-- Get the object velocity (deplacement) in a 3D environment.
		do
			Result := params_3_float ({AUDIO_EXTERNAL}.al_velocity)
		end

	x: REAL_32 assign set_x
			-- X coordinate of the position
			-- (from GAME_3D_OBJECT)
		do
			Result := position.x
		end

	y: REAL_32 assign set_y
			-- Y coordinate of the position
			-- (from GAME_3D_OBJECT)
		do
			Result := position.y
		end

	z: REAL_32 assign set_z
			-- Z coordinate of the position
			-- (from GAME_3D_OBJECT)
		do
			Result := position.z
		end
	
feature -- Comparison

	frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		do
			if a = Void then
				Result := b = Void
			else
				Result := b /= Void and then a.is_deep_equal (b)
			end
		ensure -- from ANY
			instance_free: class
			shallow_implies_deep: standard_equal (a, b) implies Result
			both_or_none_void: (a = Void) implies (Result = (b = Void))
			same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b))
			symmetric: Result implies deep_equal (b, a)
		end

	frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		do
			if a = Void then
				Result := b = Void
			else
				Result := b /= Void and then a.is_equal (b)
			end
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b))
		end

	frozen is_deep_equal alias "≡≡≡" (other: AUDIO_3D_OBJECT): BOOLEAN
			-- Are Current and other attached to isomorphic object structures?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			shallow_implies_deep: standard_is_equal (other) implies Result
			same_type: Result implies same_type (other)
			symmetric: Result implies other.is_deep_equal (Current)
		end

	is_equal (other: AUDIO_3D_OBJECT): BOOLEAN
			-- Is other attached to an object considered
			-- equal to current object?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			symmetric: Result implies other ~ Current
			consistent: standard_is_equal (other) implies Result
		end

	frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		do
			if a = Void then
				Result := b = Void
			else
				Result := b /= Void and then a.standard_is_equal (b)
			end
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b))
		end

	frozen standard_is_equal alias "≜" (other: AUDIO_3D_OBJECT): BOOLEAN
			-- Is other attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
		end
	
feature -- Status report

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of other (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		end

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of other?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))
		end
	
feature -- Duplication

	frozen clone (other: detachable ANY): like other
		obsolete "Use `twin' instead. [2017-05-31]"
			-- Void if other is void; otherwise new object
			-- equal to other
			--
			-- For non-void other, clone calls copy;
			-- to change copying/cloning semantics, redefine copy.
			-- (from ANY)
		do
			if other /= Void then
				Result := other.twin
			end
		ensure -- from ANY
			instance_free: class
			equal: Result ~ other
		end

	copy (other: AUDIO_3D_OBJECT)
			-- Update current object using fields of object attached
			-- to other, so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		external
			"built_in"
		ensure -- from ANY
			is_equal: Current ~ other
		end

	frozen deep_clone (other: detachable ANY): like other
		obsolete "Use `deep_twin' instead. [2017-05-31]"
			-- Void if other is void: otherwise, new object structure
			-- recursively duplicated from the one attached to other
			-- (from ANY)
		do
			if other /= Void then
				Result := other.deep_twin
			end
		ensure -- from ANY
			instance_free: class
			deep_equal: deep_equal (other, Result)
		end

	frozen deep_copy (other: AUDIO_3D_OBJECT)
			-- Effect equivalent to that of:
			--		copy (other . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		do
			copy (other.deep_twin)
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)
		end

	frozen deep_twin: AUDIO_3D_OBJECT
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			deep_twin_not_void: Result /= Void
			deep_equal: deep_equal (Current, Result)
		end

	frozen standard_clone (other: detachable ANY): like other
		obsolete "Use `standard_twin' instead. [2017-05-31]"
			-- Void if other is void; otherwise new object
			-- field-by-field identical to other.
			-- Always uses default copying semantics.
			-- (from ANY)
		do
			if other /= Void then
				Result := other.standard_twin
			end
		ensure -- from ANY
			instance_free: class
			equal: standard_equal (Result, other)
		end

	frozen standard_copy (other: AUDIO_3D_OBJECT)
			-- Copy every field of other onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		external
			"built_in"
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)
		end

	frozen standard_twin: AUDIO_3D_OBJECT
			-- New object field-by-field identical to other.
			-- Always uses default copying semantics.
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)
		end

	frozen twin: AUDIO_3D_OBJECT
			-- New object equal to Current
			-- twin calls copy; to change copying/twinning semantics, redefine copy.
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result ~ Current
		end
	
feature -- Basic operations

	frozen as_attached: attached AUDIO_3D_OBJECT
		obsolete "Remove calls to this feature. [2017-05-31]"
			-- Attached version of Current.
			-- (Can be used during transitional period to convert
			-- non-void-safe classes to void-safe ones.)
			-- (from ANY)
		do
			Result := Current
		end

	frozen default: detachable AUDIO_3D_OBJECT
			-- Default value of object's type
			-- (from ANY)
		do
		end

	frozen default_pointer: POINTER
			-- Default value of type POINTER
			-- (Avoid the need to write p.default for
			-- some p of type POINTER.)
			-- (from ANY)
		do
		ensure -- from ANY
			instance_free: class
		end

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)
		do
		end

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
		do
		ensure -- from ANY
			instance_free: class
		end
	
feature {NONE} -- Implementation

	assign_params_float_pointer_c (a_id: INTEGER_32; a_ptr: POINTER)
		deferred
		end

	disable_print_on_error
			-- Desactive the print_on_error functionnality.
			-- (from GAME_ERROR_MANAGER)
		do
			Print_on_error_internal.put (False)
		end

	enable_print_on_error
			-- Active the print_on_error functionnality.
			-- (from GAME_ERROR_MANAGER)
		do
			Print_on_error_internal.put (True)
		end

	manual_error: detachable READABLE_STRING_GENERAL
			-- The specific message for the last error
			-- (from GAME_ERROR_MANAGER)

	params_3_float (a_id: INTEGER_32): TUPLE [x: REAL_32; y: REAL_32; z: REAL_32]
		local
			l_params_vector: ARRAY [REAL_32]
			l_params_c: ANY
		do
			create l_params_vector.make_filled (0.0, 1, 3)
			l_params_c := l_params_vector.to_c
			clear_error
			assign_params_float_pointer_c (a_id, $l_params_c.to_pointer)
			read_al_error ("Cannot get audio floats parameters (3)")
			Result := [l_params_vector.at (1), l_params_vector.at (2), l_params_vector.at (3)]
		end

	print_on_error: BOOLEAN
			-- When an error occured, the library will print
			-- informations about the error on the error console
			-- output (default is True).
			-- (from GAME_ERROR_MANAGER)
		do
			Result := Print_on_error_internal.item
		end

	Print_on_error_internal: CELL [BOOLEAN]
			-- True when an error occured,
			-- The library will print it right away.
			-- (from GAME_ERROR_MANAGER)
		once ("PROCESS")
			create Result.put (True)
		end

	set_params_3_float (a_id: INTEGER_32; a_x, a_y, a_z: REAL_32)
		local
			l_params_vector: ARRAY [REAL_32]
			l_params_c: ANY
		do
			create l_params_vector.make_filled (0.0, 1, 3)
			l_params_vector.at (1) := a_x
			l_params_vector.at (2) := a_y
			l_params_vector.at (3) := a_z
			l_params_c := l_params_vector.to_c
			clear_error
			set_params_float_pointer_c (a_id, $l_params_c.to_pointer)
			read_al_error ("Cannot set audio float parameters (3).")
		ensure
			is_assign: not has_error implies (attached params_3_float (a_id) as la_params implies (la_params.x ~ a_x and la_params.y ~ a_y and la_params.z ~ a_z))
		end

	set_params_float_pointer_c (a_id: INTEGER_32; a_ptr: POINTER)
		deferred
		end

	set_print_on_error (a_value: BOOLEAN)
			-- Assign to print_on_error the value of a_value
			-- (from GAME_ERROR_MANAGER)
		do
			if a_value then
				enable_print_on_error
			else
				disable_print_on_error
			end
		ensure -- from GAME_ERROR_MANAGER
			is_assign: print_on_error ~ a_value
		end
	
feature {NONE} 

	clear_alc_error (a_device: POINTER)
			-- (from AUDIO_OPENAL_ERROR_MANAGER)
		do
			clear_error
			last_alc_error_code := {AUDIO_EXTERNAL}.alc_get_error (a_device)
		end

	clear_error
			-- Remove error pending in Current
			-- (from AUDIO_OPENAL_ERROR_MANAGER)
		do
			last_alc_error_code := {AUDIO_EXTERNAL}.alc_get_error (create {POINTER})
			last_al_error_code := {AUDIO_EXTERNAL}.al_get_error
			Precursor {GAME_ERROR_MANAGER}
		ensure -- from GAME_ERROR_MANAGER
			no_error: not has_error
		end

	is_error_managable: BOOLEAN
			-- Can the present error can be manage
			-- (from AUDIO_OPENAL_ERROR_MANAGER)
		do
			Result := last_al_error_code = {AUDIO_EXTERNAL}.al_out_of_memory or last_al_error_code = {AUDIO_EXTERNAL}.al_no_error
		end

	is_manual_error: BOOLEAN
			-- Is the present error a manual error
			-- (from AUDIO_OPENAL_ERROR_MANAGER)

	last_al_error_code: INTEGER_32
			-- The last error index return by the OpenAL library.
			-- (from AUDIO_OPENAL_ERROR_MANAGER)

	last_alc_error_code: INTEGER_32
			-- The last error index return by the OpenAL context library.
			-- (from AUDIO_OPENAL_ERROR_MANAGER)

	put_manual_error (a_general_message, a_specific_error: READABLE_STRING_GENERAL)
			-- Create a manual error using a_general_error for the debug information
			-- and a_specific_error for the lasting information
			-- (from AUDIO_OPENAL_ERROR_MANAGER)
		do
			last_al_error_code := {AUDIO_EXTERNAL}.al_no_error
			is_manual_error := True
			Precursor {GAME_ERROR_MANAGER} (a_general_message, a_specific_error)
		ensure -- from GAME_ERROR_MANAGER
				has_error
		end

	read_al_error (a_message: READABLE_STRING_GENERAL)
			-- Read the next OpenAL error
			-- (from AUDIO_OPENAL_ERROR_MANAGER)
		do
			last_alc_error_code := {AUDIO_EXTERNAL}.alc_no_error
			last_al_error_code := {AUDIO_EXTERNAL}.al_get_error
			has_error := last_al_error_code /= {AUDIO_EXTERNAL}.al_no_error
			if has_error and Print_on_error_internal.item then
				Io.Error.put_string (a_message.to_string_8 + "%N");
				Io.Error.put_string (last_error.to_string_8 + "%N")
			end
		end

	read_alc_error (a_device: POINTER; a_message: READABLE_STRING_GENERAL)
			-- Read the next OpenAL error
			-- (from AUDIO_OPENAL_ERROR_MANAGER)
		do
			last_al_error_code := {AUDIO_EXTERNAL}.al_no_error
			last_alc_error_code := {AUDIO_EXTERNAL}.alc_get_error (a_device)
			has_error := last_alc_error_code /= {AUDIO_EXTERNAL}.alc_no_error
			if has_error and Print_on_error_internal.item then
				Io.Error.put_string (a_message.to_string_8 + "%N");
				Io.Error.put_string (last_error.to_string_8 + "%N")
			end
		end
	
feature -- Output

	Io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		once
			create Result;
			Result.set_output_default
		ensure -- from ANY
			instance_free: class
			io_not_void: Result /= Void
		end

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		do
			Result := tagged_out
		ensure -- from ANY
			out_not_void: Result /= Void
		end

	print (o: detachable ANY)
			-- Write terse external representation of o
			-- on standard output.
			-- (from ANY)
		local
			s: READABLE_STRING_8
		do
			if attached o then
				s := o.out
				if attached {READABLE_STRING_32} s as s32 then
					Io.put_string_32 (s32)
				elseif attached {READABLE_STRING_8} s as s8 then
					Io.put_string (s8)
				else
					Io.put_string_32 (s.as_string_32)
				end
			end
		ensure -- from ANY
			instance_free: class
		end

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			tagged_out_not_void: Result /= Void
		end
	
feature -- Platform

	Operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
		once
			create Result
		ensure -- from ANY
			instance_free: class
			operating_environment_not_void: Result /= Void
		end
	
feature {NONE} -- Retrieval

	frozen internal_correct_mismatch
			-- Called from runtime to perform a proper dynamic dispatch on correct_mismatch
			-- from MISMATCH_CORRECTOR.
			-- (from ANY)
		local
			l_msg: STRING_32
			l_exc: EXCEPTIONS
		do
			if attached {MISMATCH_CORRECTOR} Current as l_corrector then
				l_corrector.correct_mismatch
			else
				create l_msg.make_from_string ("Mismatch: ".as_string_32)
				create l_exc;
				l_msg.append (generating_type.name_32);
				l_exc.raise_retrieval_exception (l_msg)
			end
		end
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

end -- class AUDIO_3D_OBJECT

Generated by ISE EiffelStudio