CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriAtomEx3dRegion Class Reference

3D region object More...

Inherits CriDisposable.

Public Member Functions

 CriAtomEx3dRegion ()
 Creates a 3D region object More...
 
override void Dispose ()
 Discards a 3D region object More...
 
bool IsDestroyable ()
 Check if 3D region can be discarded More...
 

Detailed Description

3D region object

Description:
An object for handling the 3D region.

Constructor & Destructor Documentation

CriAtomEx3dRegion ( )
inline

Creates a 3D region object

Description:
Creates a 3D region object.
Note:
The library must be initialized before calling this function.

Member Function Documentation

override void Dispose ( )
inline

Discards a 3D region object

Description:
Discards a 3D region object.
When this function is called, all the resources allocated in the DLL when creating the 3D region object are released,
and the 3D region object is disabled.
bool IsDestroyable ( )
inline

Check if 3D region can be discarded

Returns
Status of 3D region (true = can be discarded, false = cannot be discarded)
Description:
Checks if a 3D Region can be destroyed.
Calling the Dispose function will not destroy a 3D Region if there is a 3D Source, 3D Listener, or a 3D Transceiver still attached to it.
In this case, you will need to either destroy all objects that have this 3D Region attached, or attach another 3D Region handle to them in order to destroy the 3D Region.
See also
Dispose, CriAtomEx3dSource.Set3dRegion, CriAtomEx3dListener.Set3dRegion, CriAtomEx3dTransceiver.Set3dRegion

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