CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriAtomEx.Randomize3dConfig Struct Reference

Config structure used to randomize the positions of the 3D sound sources. More...

Public Member Functions

 Randomize3dConfig (bool followsOriginalSource, Randomize3dCalcType calculationType, float param1=0, float param2=0, float param3=0)
 Initializes the settings related to 3D sound source position randomization More...
 
void ClearCalcParams (float initVal=0f)
 Sets all parameters to the specified values. Sets all parameters to 0 if no argument is passed More...
 
bool GetParamByType (Randomize3dParamType paramType, ref float paramVal)
 Gets the value of a parameter by specifying the type More...
 
bool SetParamByType (Randomize3dParamType paramType, float paramVal)
 Sets the parameter by specifying the type More...
 

Properties

bool FollowsOriginalSource [get]
 Returns whether the position and orientation of the 3D sound source must be followed (read only) More...
 
Randomize3dCalcType CalculationType [get]
 Gets the shape used for 3D sound source randomization (read only) More...
 
float CalculationParameter1 [get]
 Gets Parameter 1 related to the shape used for 3D sound source randomization (read only) More...
 
float CalculationParameter2 [get]
 Gets Parameter 2 related to the shape used for 3D sound source randomization (read only) More...
 
float CalculationParameter3 [get]
 Gets Parameter 3 related to the shape used for 3D sound source randomization (read only) More...
 

Detailed Description

Config structure used to randomize the positions of the 3D sound sources.

Description:
This is the structure that contains the settings related to the randomization of the 3D sound source's position.
See also
CriAtomEx::Randomize3dCalcType

Constructor & Destructor Documentation

Randomize3dConfig ( bool  followsOriginalSource,
Randomize3dCalcType  calculationType,
float  param1 = 0,
float  param2 = 0,
float  param3 = 0 
)
inline

Initializes the settings related to 3D sound source position randomization

Member Function Documentation

void ClearCalcParams ( float  initVal = 0f)
inline

Sets all parameters to the specified values. Sets all parameters to 0 if no argument is passed

bool GetParamByType ( Randomize3dParamType  paramType,
ref float  paramVal 
)
inline

Gets the value of a parameter by specifying the type

bool SetParamByType ( Randomize3dParamType  paramType,
float  paramVal 
)
inline

Sets the parameter by specifying the type

Property Documentation

bool FollowsOriginalSource
get

Returns whether the position and orientation of the 3D sound source must be followed (read only)

Randomize3dCalcType CalculationType
get

Gets the shape used for 3D sound source randomization (read only)

float CalculationParameter1
get

Gets Parameter 1 related to the shape used for 3D sound source randomization (read only)

float CalculationParameter2
get

Gets Parameter 2 related to the shape used for 3D sound source randomization (read only)

float CalculationParameter3
get

Gets Parameter 3 related to the shape used for 3D sound source randomization (read only)


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