Public Member Functions
void	setPlatformType (Mach1PlatformType platformType)

void	setDecodeMode (Mach1DecodeMode mode)

void	setMuteWhenOutsideObject (bool muteWhenOutsideObject)

void	setMuteWhenInsideObject (bool muteWhenInsideObject)

void	setUseAttenuation (bool useAttenuation)

void	setAttenuationCurve (float attenuationCurve)

void	setUsePlaneCalculation (bool usePlaneCalculation)

void	setUseYawForRotation (bool useYawForRotation)

void	setUsePitchForRotation (bool usePitchForRotation)

void	setUseRollForRotation (bool useRollForRotation)

void	setListenerPosition (Mach1Point3D point)

void	setListenerRotation (Mach1Point3D point)

void	setListenerRotationQuat (Mach1Point4D quat)

void	setDecoderAlgoPosition (Mach1Point3D point)

void	setDecoderAlgoRotation (Mach1Point3D point)

void	setDecoderAlgoRotationQuat (Mach1Point4D quat)

void	setDecoderAlgoScale (Mach1Point3D point)

void	evaluatePositionResults ()

void	getCoefficients (float *result)

void	getCoefficients (std::vector< float > &result)

float	getDist ()

int	getFormatChannelCount ()

int	getFormatCoeffCount ()

Mach1Point3D	getCurrentAngle ()

Mach1Point3D	getCurrentAngleInternal ()

Mach1Point3D	getPositionalRotation ()

void	setFilterSpeed (float filterSpeed)

Mach1Point3D	getClosestPointOnPlane ()

Member Function Documentation

◆ getCoefficients() [1/2]

void Mach1DecodePositional::getCoefficients ( float * result )

Return the current coefficients to be applied to the audioplayer's volume

Remark: Result is returned back as the argument, an array of 18 floats is required as an input

◆ getCoefficients() [2/2]

void Mach1DecodePositional::getCoefficients ( std::vector< float > & result )

Return the current coefficients to be applied to the audioplayer's volume

Remark: Result is returned back as the argument, an array of 18 floats is required as an input

◆ getCurrentAngle()

Mach1Point3D Mach1DecodePositional::getCurrentAngle ( )

Return the current orientation angle of the m1obj

◆ getCurrentAngleInternal()

Mach1Point3D Mach1DecodePositional::getCurrentAngleInternal ( )

Returns the current angle before any platform corrections have been made intended for debug purposes only

◆ getDist()

float Mach1DecodePositional::getDist ( )

Return a distance calculation of the position of the device/camera to the position of the m1obj

◆ setAttenuationCurve()

void Mach1DecodePositional::setAttenuationCurve ( float attenuationCurve )

Set the current normalized distance per update for attenuation coefficient

Parameters:
- Normalized range: 0.0 -> 1.0

◆ setDecodeMode()

void Mach1DecodePositional::setDecodeMode ( Mach1DecodeMode mode )

Set the decoding algorithm

Parameters:
- M1Spatial_4 (default spatial | 8 channels)
- M1Spatial_8 (compass / yaw | 4 channels)
- M1Spatial_14 (higher order spatial | 14 channels)

◆ setDecoderAlgoPosition()

void Mach1DecodePositional::setDecoderAlgoPosition ( Mach1Point3D point )

Sets the decode object's position in desired x,y,z space

Parameters:
- Mach1Point3D Rotation: x,y,z

◆ setDecoderAlgoRotation()

void Mach1DecodePositional::setDecoderAlgoRotation ( Mach1Point3D point )

Sets the decode object's orientation with Euler angles

Parameters:
- Mach1Point3D Rotation: yaw,pitch,roll

◆ setDecoderAlgoRotationQuat()

void Mach1DecodePositional::setDecoderAlgoRotationQuat ( Mach1Point4D quat )

Sets the decode object's position in desired x,y,z space

Parameters:
- Mach1Point3D Rotation: x,y,z

◆ setDecoderAlgoScale()

void Mach1DecodePositional::setDecoderAlgoScale ( Mach1Point3D point )

Sets the decode object's scale in desired x,y,z space

Parameters:
- Mach1Point3D Scale: x,y,z multiplier

◆ setFilterSpeed()

void Mach1DecodePositional::setFilterSpeed ( float filterSpeed )

Filter speed determines the amount of angle smoothing applied to the orientation angles used for the Mach1DecodeCore class

Parameters:
- value range: 0.0001 -> 1.0 (where 0.1 would be a slow filter and 1.0 is no filter)

◆ setListenerPosition()

void Mach1DecodePositional::setListenerPosition ( Mach1Point3D point )

Sets the device/camera's position in desired x,y,z space

Parameters:
- Mach1Point3D Position: x,y,z

◆ setListenerRotation()

void Mach1DecodePositional::setListenerRotation ( Mach1Point3D point )

Sets the device/camera's orientation with Euler angles

Parameters:
- Mach1Point3D Rotation: yaw,pitch,roll

◆ setListenerRotationQuat()

void Mach1DecodePositional::setListenerRotationQuat ( Mach1Point4D quat )

Sets the device/camera's orientation with Quaternion

Parameters:
- Mach1Point4D Rotation: Quaternion

◆ setMuteWhenInsideObject()

void Mach1DecodePositional::setMuteWhenInsideObject ( bool muteWhenInsideObject )

Mute mach1decode object (all coefficifient results becomes 0) when inside the positional reference shape/point

◆ setMuteWhenOutsideObject()

void Mach1DecodePositional::setMuteWhenOutsideObject ( bool muteWhenOutsideObject )

Mute mach1decode object (all coefficifient results becomes 0) when outside the positional reference shape/point

◆ setPlatformType()

void Mach1DecodePositional::setPlatformType ( Mach1PlatformType platformType )

Set the device's angle order and convention if applicable

Parameters:
- Mach1PlatformDefault
- Mach1PlatformUnity
- Mach1PlatformUE
- Mach1PlatformOfEasyCam
- Mach1PlatformAndroid
- Mach1PlatformiOS
- Mach1PlatformiOSTableTop_ZVertical
- Mach1PlatformiOSPortraitHandheld_YVertical
- Mach1PlatformiOSPortrait_YawOnly

◆ setUseAttenuation()

void Mach1DecodePositional::setUseAttenuation ( bool useAttenuation )

Set distance attenuation calculations on that mach1decode object on/off

Remark: When off, distance remains 1.0

◆ setUsePitchForRotation()

void Mach1DecodePositional::setUsePitchForRotation ( bool usePitchForRotation )

Set use/ignore Pitch angle rotation results from pivoting positionally

Remark: Default is true

◆ setUsePlaneCalculation()

void Mach1DecodePositional::setUsePlaneCalculation ( bool usePlaneCalculation )

Calculate the rotation to the decode object from it's center point or from the closest point to the object on a plane

Parameters:
- True: Closest point of plane of object for calculations of rotation
- False (default): center point of object for calculations of rotation

◆ setUseRollForRotation()

void Mach1DecodePositional::setUseRollForRotation ( bool useRollForRotation )

Set use/ignore Roll angle rotation results from pivoting positionally

Remark: Default is true

◆ setUseYawForRotation()

void Mach1DecodePositional::setUseYawForRotation ( bool useYawForRotation )

Set use/ignore Yaw angle rotation results from pivoting positionally

Remark: Default is true

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

/home/runner/work/m1-sdk/m1-sdk/libmach1spatial/api_decodepositional/include/Mach1DecodePositional.h
/home/runner/work/m1-sdk/m1-sdk/libmach1spatial/api_decodepositional/include/Mach1DecodePositional.cpp

Public Member Functions