API Migration
Major Changes#
- Added a new MeshAnimation class.
- Added a new MeshRender class.
- Added a new BlendZonesData class.
- Added a new CalibrationGridData class.
- Added a new ColorCorrectionData class.
- Added a new DebugData class.
- Added a new SpiderVision::Manager class.
- Added a new DisplaysConfig class.
- Added a new EasyBlendData class.
- Added a new GroupData class.
- Added a new MasksData class.
- Added a new ViewportData class.
- Added a new WallGroupData class.
- Added a new WarpGridData class.
- Added a new VRBone class.
- Added a new VRHand class.
- Added a new VRHandTracking class.
- Removed the Syncker::Projections class.
Breaking Changes#
UGUID Migration#
We have optimized UGUIDs to reduce memory consumption. The main change is that a UGUID no longer stores a string. Combined with internal enhancements, this made the UGUID 52 bytes smaller than its previous version.
These changes will require some manual code migration in case your project contains UGUID managemet via API.
- Replace all UGUID::getString() calls with UGUID::makeString().
2.18.1 const char *guid_str = guid.getString(); Unigine::Log::message("Guid string %s\n", guid.getString());
2.19 GUIDString guid_str = guid.makeString(); Unigine::Log::message("Guid string %s\n", guid.makeString().get());
- Replace all UGUID::get() calls with FileSystem::guidToPath(const UGUID &guid).
2.18.1 const char *guid_str = guid.get(); Unigine::Log::message("Guid string %s\n", guid.get());
2.19 String guid_str = Unigine::FileSystem::guidToPath(guid); Unigine::Log::message("Guid file system string %s\n", Unigine::FileSystem::guidToPath(guid).get());
- Replace all UGUID::getFileSystemString() calls with FileSystem::guidToPath(const UGUID &guid).
The method has been moved to the FileSystem class.
2.18.1 const char *guid_str = guid.getFileSystemString(); Unigine::Log::message("Guid string %s\n", guid.getFileSystemString());
2.19 String guid_str = Unigine::FileSystem::guidToPath(guid); Unigine::Log::message("Guid file system string %s\n", Unigine::FileSystem::guidToPath(guid).get());
- Replace all UGUID::setFileSystemString(const char* str) calls with FileSystem::pathToGuid(const char* str).
The method has been moved to the FileSystem class.
2.18.1 UGUID guid; guid.setFileSystemString("guid://dd39448b6c7f113dc1063ec864de885476c9ba3b");
2.19 UGUID guid = Unigine::FileSystem::pathToGuid("guid://dd39448b6c7f113dc1063ec864de885476c9ba3b");
Event Connection Migration#
If the direct subscription to events (without specifying an istance of the EventConnection/EventConnections class) doesn't compile now:
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
connect( set of args ) | Replaced with connectUnsafe( set of args ). |
BodyFracture Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setMaterialPath( const char * ) | Renamed as setMaterialFilePath( const char * ). |
getMaterialPath( ) | Renamed as getMaterialFilePath( ). |
BonesRetargeting Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
loadMeshes( const char *, const char * ) | Removed. Use loadBones( const char *, const char * ), loadBonesFromMeshes( const Ptr<Mesh> &, const Ptr<Mesh> & ), or loadBloadBonesFromObjects( const Ptr<ObjectMeshSkinned> &, const Ptr<ObjectMeshSkinned> & ) instead. |
New Functions
BootConfig Class#
Decal Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setMaterialPath( const char * ) | Renamed as setMaterialFilePath( const char * ). |
getMaterialPath( ) | Renamed as getMaterialFilePath. |
DecalMesh Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
getMeshInfo( ) | Removed. Use getMeshCurrentRAM( ) and getMeshCurrentVRAM( ) instead. |
getMeshForce( ) | Removed. Use getMeshForceRAM( ) and getMeshForceVRAM( ) instead. |
getMeshAsync( ) | Removed. Use getMeshAsyncRAM( ) and getMeshAsyncVRAM( ) instead. |
getMeshForceVRAM( ) | Return value type changed. |
getMeshAsyncVRAM( ) | Return value type changed. |
New Functions
Engine Class#
EngineWindowViewport Class#
FileSystem Class#
ImportProcessor Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
processAnimation( const Ptr<MeshAnimation> &, const Ptr<ImportAnimation> & ) | Set of arguments changed. |
processAnimation( const Ptr<MeshAnimation> &, const Ptr<ImportMesh> &, const Ptr<ImportAnimation> & ) | Set of arguments changed. |
onProcessAnimation( const Ptr<MeshAnimation> &, const Ptr<ImportAnimation> & ) | Set of arguments changed. |
onProcessAnimation( const Ptr<MeshAnimation> &, const Ptr<ImportMesh> &, const Ptr<ImportAnimation> & ) | Set of arguments changed. |
Importer Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
importAnimation( const Ptr<ImportProcessor> &, const Ptr<MeshAnimation> &, const Ptr<ImportAnimation> & ) | Set of arguments changed. |
importAnimation( const Ptr<ImportProcessor> &, const Ptr<MeshAnimation> &, const Ptr<ImportMesh> &, const Ptr<ImportAnimation> & ) | Set of arguments changed. |
onImportAnimation( const Ptr<ImportProcessor> &, const Ptr<MeshAnimation> &, const Ptr<ImportAnimation> & ) | Set of arguments changed. |
onImportAnimation( const Ptr<ImportProcessor> &, const Ptr<MeshAnimation> &, const Ptr<ImportMesh> &, const Ptr<ImportAnimation> & ) | Set of arguments changed. |
New Functions
Input Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
VR_BUTTON_SYSTEM_LEFT | Removed. |
VR_BUTTON_SYSTEM_RIGHT | Removed. |
VR_BUTTON_A | Removed. |
VR_BUTTON_B | Removed. |
VR_BUTTON_GRIP_LEFT | Removed. |
VR_BUTTON_GRIP_RIGHT | Removed. |
VR_BUTTON_AXIS_0_LEFT | Removed. |
VR_BUTTON_AXIS_0_RIGHT | Removed. |
VR_BUTTON_AXIS_1_LEFT | Removed. |
VR_BUTTON_AXIS_1_RIGHT | Removed. |
VR_BUTTON_AXIS_2_LEFT | Removed. |
VR_BUTTON_AXIS_2_RIGHT | Removed. |
VR_BUTTON_AXIS_3_LEFT | Removed. |
VR_BUTTON_AXIS_3_RIGHT | Removed. |
VR_BUTTON_AXIS_4_LEFT | Removed. |
VR_BUTTON_AXIS_4_RIGHT | Removed. |
New Functions
- VR_BUTTON_SYSTEM
- VR_BUTTON_START
- VR_BUTTON_HOME
- VR_BUTTON_END
- VR_BUTTON_SELECT
- VR_BUTTON_VOLUME_UP
- VR_BUTTON_VOLUME_DOWN
- VR_BUTTON_MUTE_MIC
- VR_BUTTON_PLAY_PAUSE
- VR_BUTTON_MENU
- VR_BUTTON_VIEW
- VR_BUTTON_BACK
- VR_BUTTON_GRIP
- VR_BUTTON_AXIS_0
- VR_BUTTON_AXIS_1
- VR_BUTTON_AXIS_2
- VR_BUTTON_AXIS_3
- VR_BUTTON_AXIS_4
- VR_BUTTON_AXIS_5
- VR_BUTTON_AXIS_6
- VR_BUTTON_AXIS_7
- VR_BUTTON_AXIS_8
- VR_BUTTON_AXIS_9
- VR_BUTTON_AXIS_10
- VR_BUTTON_AXIS_11
- VR_BUTTON_AXIS_12
- VR_BUTTON_AXIS_13
- VR_BUTTON_AXIS_14
- VR_BUTTON_AXIS_15
- VR_BUTTON_THUMBREST
- VR_BUTTON_THUMB_RESTING_SURFACES
- VR_BUTTON_SHOULDER
- VR_BUTTON_DPAD_CENTER
InputVRController Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setVibration( unsigned short ) | Removed. |
New Functions
- AXIS_TYPE_TRACKPAD_X
- AXIS_TYPE_TRACKPAD_Y
- AXIS_TYPE_TRACKPAD_FORCE
- AXIS_TYPE_JOYSTICK_X
- AXIS_TYPE_JOYSTICK_Y
- AXIS_TYPE_JOYSTICK_FORCE
- AXIS_TYPE_GRIP_VALUE
- AXIS_TYPE_GRIP_FORCE
- AXIS_TYPE_TRIGGER_VALUE
- AXIS_TYPE_TRIGGER_FORCE
- AXIS_TYPE_TRIGGER_CURL_VALUE
- AXIS_TYPE_TRIGGER_CURL_FORCE
- AXIS_TYPE_TRIGGER_SLIDE_VALUE
- AXIS_TYPE_TRIGGER_SLIDE_FORCE
- AXIS_TYPE_PINCH_VALUE
- AXIS_TYPE_GRASP_VALUE
- AXIS_TYPE_AIM_ACTIVATE_VALUE
- applyHaptic( float, double, float )
- stopHaptic( )
- getSupportedButtonsMask( )
- findAxisByType( InputVRController::AXIS_TYPE )
- getAxisByType( InputVRController::AXIS_TYPE )
- isUsingHandTracking( )
InputVRDevice Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
getWorldTransform( InputVRDevice::TRANSFORM_TYPE ) | Set of arguments changed. |
getTransform( InputVRDevice::TRANSFORM_TYPE ) | Set of arguments changed. |
getLinearVelocity( InputVRDevice::TRANSFORM_TYPE ) | Set of arguments changed. |
getAngularVelocity( InputVRDevice::TRANSFORM_TYPE ) | Set of arguments changed. |
getAngularAcceleration( InputVRDevice::TRANSFORM_TYPE ) | Set of arguments changed. |
isTransformValid( InputVRDevice::TRANSFORM_TYPE ) | Set of arguments changed. |
New Functions
InputVRHead Class#
Light Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setBakedDepthTexturePath( const char * ) | Renamed as setBakedDepthTextureFilePath( const char * ). |
getBakedDepthTexturePath( ) | Renamed as getBakedDepthTextureFilePath( ). |
New Functions
LightEnvironmentProbe Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setTexturePath( const char * ) | Renamed as setTextureFilePath( const char * ). |
getTexturePath( ) | Renamed as getTextureFilePath( ). |
New Functions
LightOmni Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setTexturePath( const char * ) | Renamed as setTextureFilePath( const char * ). |
getTexturePath( ) | Renamed as getTextureFilePath( ). |
LightProj Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setTexturePath( const char * ) | Renamed as setTextureFilePath( const char * ). |
getTexturePath( ) | Renamed as getTextureFilePath( ). |
LightVoxelProbe Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setTexturePath( const char * ) | Renamed as setTextureFilePath( const char * ). |
getTexturePath( ) | Renamed as getTextureFilePath( ). |
Material Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setDepthMask( int ) | Removed. |
getDepthMask( ) | Removed. |
OPTION_DEPTH_MASK | Removed. |
TEXTURE_SOURCE_INDIRECT_DIFFUSE | Renamed as TEXTURE_SOURCE_INDIRECT_DIFFUSE_FINAL. |
TEXTURE_SOURCE_INDIRECT_SPECULAR | Renamed as TEXTURE_SOURCE_INDIRECT_SPECULAR_FINAL. |
New Functions
Memory Class#
Mesh Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setAnimationBones( int, const Vector< short > & ) | Removed. Use MeshAnimation::setAnimationBones( const Vector< short > & ) instead. |
getAnimationBones( int, Vector< short > & ) | Removed. Use MeshAnimation::getAnimationBones( Vector< short > & ) instead. |
setAnimationFrame( int, int, const Vector< Math::vec3 > &, const Vector< Math::quat > &, const Vector< Math::vec3 > &, int, int, int ) | Removed. Use MeshAnimation::setFrame( int, const Vector< Math::vec3 > &, const Vector< Math::quat > &, const Vector< Math::vec3 > & ) instead. |
setAnimationFrame( int, int, int, const Vector< Math::mat4 > & ) | Removed. Use MeshAnimation::setFrame( int, const Vector< Math::mat4 > & ) instead. |
getAnimationFrame( int, int, Vector< Math::vec3 > &, Vector< Math::quat > &, Vector< Math::vec3 > &, int ) | Removed. Use MeshAnimation::getFrame( int, Vector< Math::vec3 > &, Vector< Math::quat > &, Vector< Math::vec3 > & ) instead. |
getAnimationFrame( int, int, int, int, int, int, Vector< Math::mat4 > & ) | Removed. Use MeshAnimation::getFrame( int, Vector< Math::mat4 > & ) instead. |
setAnimationName( int, const char * ) | Removed. |
getAnimationName( int ) | Removed |
setBoneTransforms( const Vector<Math::mat4> & ) | Set of arguments changed. |
getBoneTransforms( Vector<Math::mat4> & ) | Set of arguments changed. |
setNumAnimationFrames( int, int ) | Removed. Use MeshAnimation::setNumFrames( int ) instead. |
getNumAnimationFrames( int ) | Removed. Use MeshAnimation::getNumFrames( int ) instead. |
getNumAnimations( ) | Removed. |
addAnimation( const char * ) | Removed. The mesh doesn't store animations anymore, animations are accessible via the path. Use ObjectMeshSkinned::setLayerAnimationFilePath( int, const char * ) or ObjectMeshSkinned::setLayerAnimationResourceID( int, long long ) instead. |
findAnimation( const char * ) | Removed. |
sortAnimations( ) | Removed. |
createIntersection( int ) | Removed. |
New Functions
Node Class#
Object Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
Enum STREAMING_OBJECT_MESH | Removed. |
setMaterialPath( const char *, int ) | Renamed as setMaterialFilePath( const char *, int ). |
setMaterialPath( const char *, const char * ) | Renamed as setMaterialFilePath( const char *, const char * ). |
getMaterialPath( int ) | Renamed as getMaterialFilePath( int ). |
ObjectMeshCluster Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
getMeshInfo( ) | Removed. Use getMeshCurrentRAM( ) and getMeshCurrentVRAM( ) instead. |
getMeshForce( ) | Removed. Use getMeshForceRAM( ) and getMeshForceVRAM( ) instead. |
getMeshAsync( ) | Removed. Use getMeshAsyncRAM( ) and getMeshAsyncVRAM( ) instead. |
getMeshForceVRAM( ) | Return value type changed. |
getMeshAsyncVRAM( ) | Return value type changed. |
setMeshStreamingModeRAM( Object::STREAMING_OBJECT_MESH ) | Removed. |
getMeshStreamingModeRAM( ) | Removed. |
setMeshStreamingModeVRAM( Object::STREAMING_OBJECT_MESH ) | Removed. |
getMeshStreamingModeVRAM( ) | Removed. |
New Functions
ObjectMeshClutter Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
getMeshInfo( ) | Removed. Use getMeshCurrentRAM( ) and getMeshCurrentVRAM( ) instead. |
getMeshForce( ) | Removed. Use getMeshForceRAM( ) and getMeshForceVRAM( ) instead. |
getMeshAsync( ) | Removed. Use getMeshAsyncRAM( ) and getMeshAsyncVRAM( ) instead. |
getMeshForceVRAM( ) | Return value type changed. |
getMeshAsyncVRAM( ) | Return value type changed. |
setMeshStreamingModeRAM( Object::STREAMING_OBJECT_MESH ) | Removed. |
getMeshStreamingModeRAM( ) | Removed. |
setMeshStreamingModeVRAM( Object::STREAMING_OBJECT_MESH ) | Removed. |
getMeshStreamingModeVRAM( ) | Removed. |
New Functions
ObjectGuiMesh Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
getMeshInfo( ) | Removed. Use getMeshCurrentRAM( ) and getMeshCurrentVRAM( ) instead. |
getMeshForce( ) | Removed. Use getMeshForceRAM( ) and getMeshForceVRAM( ) instead. |
getMeshAsync( ) | Removed. Use getMeshAsyncRAM( ) and getMeshAsyncVRAM( ) instead. |
getMeshForceVRAM( ) | Return value type changed. |
getMeshAsyncVRAM( ) | Return value type changed. |
setMeshStreamingModeRAM( Object::STREAMING_OBJECT_MESH ) | Removed. |
getMeshStreamingModeRAM( ) | Removed. |
setMeshStreamingModeVRAM( Object::STREAMING_OBJECT_MESH ) | Removed. |
getMeshStreamingModeVRAM( ) | Removed. |
New Functions
ObjectMeshSkinned Class#
A critical change is that now procedural source meshes for ObjectMeshSkinned are created and modified via the Mesh class. Thus, the process of creating a procedural mesh has changed:
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
|
|
Other changes to such meshes are introduced using the corresponding updated methods, as described below.
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
Enum FRAME_USES | Renamed as ANIM_FRAME_USES. |
ObjectMeshSkinned( const Ptr<Mesh> & ) | Removed. Use applyMeshProcedural( const Ptr<Mesh> & ) instead. |
ObjectMeshSkinned( const char *, bool ) | Removed. If unique=true, use applyMeshProcedural( const Ptr<Mesh> & ) instead. |
setAnimation( int, variable, int )
|
Removed. Use getAnimationResourceID( const char * ) or setLayerAnimationResourceID( int, long long ) instead.
|
setAnimation( int, const char * ) |
Removed. Use setLayerAnimationFilePath( int, const char * ) instead. |
getAnimation( int ) |
Removed. Use getLayerAnimationResourceID( int ) instead. |
getAnimationID( int )
|
Removed. Use getAnimationResourceID( const char * ) instead.
|
getAnimationPath( int )
|
Removed. Use getLayerAnimationFilePath( int ) instead.
|
setAnimName( const char * ) | Removed. Use setAnimPath( const char * ) instead. Animation is applied immediately now (as was by using SetAnimNameForce in earlier versions). |
setAnimNameForce( const char * ) | Removed. Use setAnimPath( const char * ) instead. |
getAnimName( ) | Removed. Use getAnimPath( const char * ) instead. |
getBoneBindTransform( int ) | Removed. Use getBoneBindLocalTransform( int ) instead. |
setCIndex( int, int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
setColor( int, const Math::vec4 &, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
setFrame( int, float, int, int ) | Removed. Use setLayerFrame( int, float, int, int ) instead. |
getFrame( int ) | Removed. Use getLayerFrame( int ) instead. |
getFrameFrom( int ) | Removed. Use getLayerFrameFrom( int ) instead. |
getFrameTo( int ) | Removed. Use getLayerFrameTo( int ) instead. |
getBoneBindITransform( int ) | Removed. Use getBoneBindObjectITransform( int ) instead. |
getBoneITransform( int ) | Removed. Use getBoneBindObjectITransform( int ) or inverse(getBoneTransform(bone)) instead. |
setBoneLayerTransform( int, int, const Math::mat4 & ) | Removed. Use setLayerBoneTransform( int, int, const Math::mat4 & ) instead. |
getBoneLayerTransform( int, int ) | Removed. Use getLayerBoneTransform( int, int ) instead. |
isBoneLayerTransform( int, int ) | Removed. Use isLayerBoneTransform( int, int ) instead. |
setBoneLayerTransformEnabled( int, int, bool ) | Removed. Use setLayerBoneTransformEnabled( int, int, bool ) instead. |
setMesh( const Ptr<Mesh> & )
|
Removed. Use applyMeshProcedural( const Ptr<Mesh> & ) instead.
|
setMeshName( const char * ) | Removed. Use setMeshPath( const char * ) instead. Animation is applied immediately now (as was by using SetAnimNameForce in earlier versions). |
setMeshNameForce( const char * ) | Removed. Use setMeshPath( const char * ) instead. |
getMeshName( ) | Removed. Use getMeshPath( ) instead. |
getNumAnimationBones( int )
|
Removed. Use MeshAnimation::getNumAnimationBones( ) instead.
|
getNumAnimationFrames( int )
|
Removed. Use MeshAnimation::getNumFrames( int ) instead.
|
getNumAnimations( ) | Removed. |
getNumFrames( int ) | Removed. Use getLayerNumFrames( int ) instead. |
setNumTargets( int, int ) | Removed. Now the mesh has a fixed set of targets that are configured via setSurfaceTargetEnabled( int, int, bool ) and setSurfaceTargetWeight( int, int, float ). |
getNumTargets( int ) | Removed. Use getNumSurfaceTargets( int ) instead. |
setNumTexCoords0( int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
setNumTexCoords1( int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
isFlushed( ) | Removed. |
setSurfaceTransform( const Math::mat4 &, int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
setTangent( int, const Math::quat &, int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
setTarget( int, bool, int, float, int )
|
Removed. Now the mesh has a fixed set of targets that are configured via setSurfaceTargetEnabled( int, int, bool ) and setSurfaceTargetWeight( int, int, float ).
|
setTargetEnabled( int, bool, int ) | Removed. Use setSurfaceTargetEnabled( int, int, bool ) instead. |
isTargetEnabled( int, int ) | Removed. Use isSurfaceTargetEnabled( int, int ) instead. |
setTargetIndex( int, int, int ) | Removed. Now the mesh has a fixed set of targets that are configured via setSurfaceTargetEnabled( int, int, bool ) and setSurfaceTargetWeight( int, int, float ). |
getTargetIndex( int, int ) | Removed. Now the mesh has a fixed set of targets that are configured via setSurfaceTargetEnabled( int, int, bool ) and setSurfaceTargetWeight( int, int, float ). |
setTargetWeight( int, float, int ) | Removed. Use setSurfaceTargetWeight( int, int, float ) instead. |
getTargetWeight( int, int ) | Removed. Use getSurfaceTargetWeight( int, int ) instead. |
setTexCoord0( int, const Math::vec2 &, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
setTexCoord1( int, const Math::vec2 &, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
setTIndex( int, int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
setVertex( int, const Math::vec3 &, int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
addAnimation( const Ptr<Mesh> &, const char * ) | Removed. The mesh doesn't store animations anymore, animations are accessible via the path. Use ObjectMeshSkinned::setLayerAnimationFilePath( int, const char * ) or ObjectMeshSkinned::setLayerAnimationResourceID( int, long long ) instead. |
addAnimation( const char * ) | Removed. The mesh doesn't store animations anymore, animations are accessible via the path. Use ObjectMeshSkinned::setLayerAnimationFilePath( int, const char * ) or ObjectMeshSkinned::setLayerAnimationResourceID( int, long long ) instead. |
addRetargetedAnimation( const char *, const Ptr<BonesRetargeting> & )
|
Removed. Use setRetargeting( const Ptr<BonesRetargeting> &, const char *, const char * ) instead.
|
addRetargetedAnimation( const Ptr<Mesh> &, const Ptr<BonesRetargeting> &, const char * ) | Removed. Use setRetargeting( const Ptr<BonesRetargeting> &, const char *, const char * ) instead. |
addEmptySurface( const char *, int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
addMeshSurface( variable, variable, const char *, const Ptr<ObjectMeshSkinned> &, int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
addMeshSurface( int, const Ptr<ObjectMeshSkinned> &, int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
addMeshSurface( const char *, const Ptr<Mesh> &, int, int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
addSurfaceTarget( int, const char * )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
addSurfaceTarget( int, const Ptr<ObjectMeshSkinned> &, int, int ) | Removed. |
addTarget( int ) | Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class. |
createMesh( const char *, bool )
|
Removed. Use these two methods instead: setMeshProceduralMode(true) and applyMeshProcedural(mesh)
|
findAnimation( const char * ) | Removed. You can use getAnimationResourceID() instead: the return value of 0 means that there is no animation. |
findSurfaceTarget( int, const char * ) | Set of arguments changed. |
flushMesh( ) | Removed. |
loadMesh( const char * ) | Removed. Use setMeshPath( const char * ) instead. |
mergeMeshSurface( int, const Ptr<ObjectMeshSkinned> &, int ) | Removed. |
removeAnimation( int ) | Removed. |
removeTarget( int, int ) | Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class. |
saveMesh( const char * ) | Removed. The mesh is now addressed via path and doesn't require saving. If the mesh is procedural, it should be saved using the corresponding method of the Mesh class. |
updateSurfaceBounds( int )
|
Removed. This parameter is now set and configured via the procedural mesh settings. The mesh therefore shall be created and modified via the Mesh class.
|
setBoneFrameUses( int, int, ObjectMeshSkinned::FRAME_USES ) | Removed. Use setLayerBoneFrameUses( int, int, ObjectMeshSkinned::ANIM_FRAME_USES ) instead. |
getBoneFrameUses( int, int ) | Removed. Use getLayerBoneFrameUses( int, int ) instead. |
getIKChain( int ) | Removed. Use getIKChainID( int ) instead. |
setIKChainUsePoleVector( bool, int ) | Removed. Use setIKChainConstraint( ObjectMeshSkinned::CHAIN_CONSTRAINT, int ) instead. |
isIKChainUsePoleVector( int ) | Removed. Use getIKChainConstraint( int ) instead. |
New Functions
- INTERPOLATION_ACCURACY_LOW
- INTERPOLATION_ACCURACY_MEDIUM
- INTERPOLATION_ACCURACY_HIGH
- CHAIN_CONSTRAINT_NONE
- CHAIN_CONSTRAINT_POLE_VECTOR
- CHAIN_CONSTRAINT_BONE_ROTATIONS
- getBoneConstraintRollMaxAngle( int )
- getBoneConstraintRollMinAngle( int )
- setBoneConstraintRollAngles( float, float, int )
- getBoneConstraintPitchMaxAngle( int )
- getBoneConstraintPitchMinAngle( int )
- setBoneConstraintPitchAngles( float, float, int )
- getBoneConstraintYawMaxAngle( int )
- getBoneConstraintYawMinAngle( int )
- setBoneConstraintYawAngles( float, float, int )
- getBoneConstraintRollAxis( int )
- setBoneConstraintRollAxis( const Math::vec3 &, int )
- getBoneConstraintPitchAxis( int )
- setBoneConstraintPitchAxis( const Math::vec3 &, int )
- getBoneConstraintYawAxis( int )
- setBoneConstraintYawAxis( const Math::vec3 &, int )
- getBoneConstraintBoneIndex( int )
- isBoneConstraintEnabled( int )
- setBoneConstraintEnabled( bool, int )
- findBoneConstraint( const char * )
- findBoneConstraint( int )
- getNumBoneConstraints( )
- removeBoneConstraint( int )
- addBoneConstraint( const char * )
- addBoneConstraint( int )
- addIKChainBone( const char *, int )
- getIKChainConstraint( int )
- setIKChainConstraint( ObjectMeshSkinned::CHAIN_CONSTRAINT, int )
- getIKChainID( int )
- getLookAtChainPoleWorldPosition( int )
- setLookAtChainPoleWorldPosition( const Math::Vec3 &, int )
- getLookAtChainPolePosition( int )
- setLookAtChainPolePosition( const Math::Vec3 &, int )
- getLookAtChainTargetWorldPosition( int )
- setLookAtChainTargetWorldPosition( const Math::Vec3 &, int )
- getLookAtChainTargetPosition( int )
- setLookAtChainTargetPosition( const Math::Vec3 &, int )
- getLookAtChainBoneAxis( int, int )
- setLookAtChainBoneAxis( const Math::Vec3 &, int, int )
- getLookAtChainBoneUp( int, int )
- setLookAtChainBoneUp( const Math::Vec3 &, int, int )
- getLookAtChainBoneWeight( int, int )
- setLookAtChainBoneWeight( float, int, int )
- getLookAtChainBone( int, int )
- removeLookAtChainBone( int, int )
- getLookAtChainNumBones( int )
- addLookAtChainBone( const char *, int )
- addLookAtChainBone( int, int )
- getLookAtChainWeight( int )
- setLookAtChainWeight( float, int )
- getLookAtChainConstraint( int )
- setLookAtChainConstraint( ObjectMeshSkinned::CHAIN_CONSTRAINT, int )
- isLookAtChainEnabled( int )
- setLookAtChainEnabled( bool, int )
- getLookAtChainID( int )
- getNumLookAtChains( )
- removeLookAtChain( int )
- addLookAtChain( )
- clearVisualizeConstraint( )
- removeVisualizeConstraint( int )
- addVisualizeConstraint( int )
- clearVisualizeLookAtChain( )
- removeVisualizeLookAtChain( int )
- addVisualizeLookAtChain( int )
- getBoneSkiningTransform( int )
- getBoneBindObjectITransform( int )
- getBoneBindObjectTransform( int )
- getBoneBindLocalITransform( int )
- getBoneBindLocalTransform( int )
- getLayerAnimationResourceID( int )
- setLayerAnimationResourceID( int, long long )
- getLayerAnimationFilePath( int )
- setLayerAnimationFilePath( int, const char * )
- getAnimationResourceID( const char * )
- isRetargeting( const char *, const char * )
- getRetargeting( const char *, const char * )
- removeRetargeting( const char *, const char * )
- setRetargeting( const Ptr<BonesRetargeting> &, const char *, const char * )
- getLayerFrameTo( int )
- getLayerFrameFrom( int )
- getLayerFrame( int )
- setLayerFrame( int, float, int, int )
- getLayerNumFrames( int )
- getLayerBoneFrameUses( int, int )
- setLayerBoneFrameUses( int, int, ObjectMeshSkinned::ANIM_FRAME_USES )
- isLayerFrameUsesEnabled( int )
- setLayerFrameUsesEnabled( int, bool )
- getLayerBoneScale( int, int )
- setLayerBoneScale( int, int, const Math::vec3 & )
- getLayerBoneRotation( int, int )
- setLayerBoneRotation( int, int, const Math::quat & )
- getLayerBonePosition( int, int )
- setLayerBonePosition( int, int, const Math::vec3 & )
- isLayerBoneTransform( int, int )
- getLayerBoneTransform( int, int )
- setLayerBoneTransform( int, int, const Math::mat4 & )
- setLayerBoneTransformEnabled( int, int, bool )
- getSurfaceTargetWeight( int, int )
- setSurfaceTargetWeight( int, int, float )
- isSurfaceTargetEnabled( int, int )
- setSurfaceTargetEnabled( int, int, bool )
- getInterpolationAccuracy( )
- setInterpolationAccuracy( ObjectMeshSkinned::INTERPOLATION_ACCURACY )
- getAnimPath( )
- setAnimPath( const char * )
- isMeshProceduralMode( )
- setMeshProceduralMode( bool )
- isLoaded( )
- getMeshPath( )
- setMeshPath( const char * )
ObjectMeshStatic Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setLightmapTexturePath( const char *, int ) | Renamed as setLightmapTextureFilePath( const char *, int ). |
getLightmapTexturePath( int ) | Renamed as getLightmapTextureFilePath( int ). |
getMeshInfo( ) | Removed. Use getMeshCurrentRAM( ) and getMeshCurrentVRAM( ) instead. |
getMeshForce( ) | Removed. Use getMeshForceRAM( ) and getMeshForceVRAM( ) instead. |
getMeshAsync( ) | Removed. Use getMeshAsyncRAM( ) and getMeshAsyncVRAM( ) instead. |
getMeshForceVRAM( ) | Return value type changed. |
getMeshAsyncVRAM( ) | Return value type changed. |
setMeshStreamingModeRAM( Object::STREAMING_OBJECT_MESH ) | Removed. |
getMeshStreamingModeRAM( ) | Removed. |
setMeshStreamingModeVRAM( Object::STREAMING_OBJECT_MESH ) | Removed. |
getMeshStreamingModeVRAM( ) | Removed. |
New Functions
ObjectText Class#
Package Class#
PackageUng Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
readFile( unsigned char *, size_t ) | Type of argument changed. |
selectFile( const char *, size_t & ) | Type of argument changed. |
writeFile( const char *, const unsigned char *, size_t ) | Type of argument changed. |
New Functions
Property Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setPath( const char * ) | Renamed as setFilePath( const char * ). |
getPath( ) | Renamed as getFilePath( ). |
Render Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
Enum STREAMING_MESHES | Removed. |
Enum STREAMING_TEXTURES | Removed. |
setStreamingMaxThreads( int ) | Removed. |
getStreamingMaxThreads() | Removed. |
setStreamingBudgetLoading( float ) | Removed. |
getStreamingBudgetLoading() | Removed. |
setStreamingBudgetDestroyTextures( float ) | Removed. |
getStreamingBudgetDestroyTextures() | Removed. |
setStreamingBudgetDestroyMeshes( float ) | Removed. |
getStreamingBudgetDestroyMeshes() | Removed. |
setStreamingTexturesMemoryLimit( int ) | Removed. |
getStreamingTexturesMemoryLimit() | Removed. |
setStreamingTexturesLifeTime( int ) | Removed. |
getStreamingTexturesLifeTime() | Removed. |
setStreamingMeshesLimitVRAM( int ) | Removed. |
getStreamingMeshesLimitVRAM() | Removed. |
setStreamingMeshesLifeTimeVRAM( int ) | Removed. |
getStreamingMeshesLifeTimeVRAM() | Removed. |
setStreamingMeshesLimitRAM( int ) | Removed. |
getStreamingMeshesLimitRAM() | Removed. |
setStreamingMeshesLifeTimeRAM( int ) | Removed. |
getStreamingMeshesLifeTimeRAM() | Removed. |
getGPUMemory() | Removed. |
getGPUName() | Removed. |
setMaxNumActiveTargets( int ) | Removed. |
getMaxNumActiveTargets() | Removed. |
destroyCacheTexture( const UGUID& ) | Removed. |
createCacheTexture( const UGUID& ) | Removed. |
destroyCacheTextures( ) | Removed. |
unloadCacheTextures( ) | Removed. |
loadCacheTextures( ) | Removed. |
getCacheTexture( const UGUID &, bool ) | Set of arguments changed. |
getGLContext( ) | Removed. |
reloadCacheTexture( const UGUID & ) | Removed. |
New Functions
- STREAMING_MODE_ASYNC
- STREAMING_MODE_FORCE
- STREAMING_VRAM_BUDGET_SYSTEM
- STREAMING_VRAM_BUDGET_DRIVER
- STREAMING_VRAM_BUDGET_FULL_GPU_MEMORY
- SHOW_TEXTURE_RESOLUTION_STREAMING_ACCOUNTING_MODE_ACTUAL
- SHOW_TEXTURE_RESOLUTION_STREAMING_ACCOUNTING_MODE_REQUESTED
- SHOW_TEXTURE_RESOLUTION_STREAMING_ACCOUNTING_MODE_SOURCE
- MATERIALS_QUALITY_LOW
- MATERIALS_QUALITY_MEDIUM
- MATERIALS_QUALITY_HIGH
- getEventEndFrameExecuteCommandLists()
- getShowTextureResolutionStreamingAccountingMode( )
- setShowTextureResolutionStreamingAccountingMode( Render::SHOW_TEXTURE_RESOLUTION_STREAMING_ACCOUNTING )
- getIndirectLightingInterleavedSamples( )
- setIndirectLightingInterleavedSamples( int )
- getIndirectLightingInterleavedColorClamping( )
- setIndirectLightingInterleavedColorClamping( int )
- isIndirectLightingInterleavedCatmullResampling( )
- setIndirectLightingInterleavedCatmullResampling( bool )
- getIndirectLightingInterleavedColorClampingVelocityThreshold( )
- setIndirectLightingInterleavedColorClampingVelocityThreshold( float )
- getIndirectLightingInterleavedColorClampingIntensity( )
- setIndirectLightingInterleavedColorClampingIntensity( float )
- getLocalTonemapperColorDifferenceThreshold( )
- setLocalTonemapperColorDifferenceThreshold( float )
- isLocalTonemapperColorDifferenceEnabled( )
- setLocalTonemapperColorDifferenceEnabled( bool )
- isLocalTonemapperDepthDifferenceEnabled( )
- setLocalTonemapperDepthDifferenceEnabled( bool )
- getLocalTonemapperBlurUpscaleKernelSize( )
- setLocalTonemapperBlurUpscaleKernelSize( int )
- isLocalTonemapperBlurUpscale( )
- setLocalTonemapperBlurUpscale( bool )
- getLocalTonemapperBlurResolution( )
- setLocalTonemapperBlurResolution( int )
- isLocalTonemapperDebug( )
- setLocalTonemapperDebug( bool )
- getLocalTonemapperEffectOnDarkAreasGamma( )
- setLocalTonemapperEffectOnDarkAreasGamma( float )
- getDenoiseColorClampingBlurResolution( )
- setDenoiseColorClampingBlurResolution( int )
- getDenoiseWrongVelocityFixByDepthThreshold( )
- setDenoiseWrongVelocityFixByDepthThreshold( float )
- isDenoiseWrongVelocityFixByDepthEnabled( )
- setDenoiseWrongVelocityFixByDepthEnabled( bool )
- getTAAInformationLostFrameCount( )
- setTAAInformationLostFrameCount( float )
- getTAAInformationLostDepthThreshold( )
- setTAAInformationLostDepthThreshold( float )
- setStreamingAnimationsLifeTime( int )
- getStreamingAnimationsLifeTime( )
- getStreamingTexturesMipmapsDensity( )
- setStreamingTexturesMipmapsDensity( float )
- isStreamingTexturesMipmaps( )
- setStreamingTexturesMipmaps( bool )
- getStreamingVRAMBudget( )
- setStreamingVRAMBudget( Render::STREAMING_VRAM_BUDGET )
- isStreamingVRAMOvercommit( )
- setStreamingVRAMOvercommit( bool )
- getStreamingFreeSpaceRAM( )
- setStreamingFreeSpaceRAM( int )
- getStreamingFreeSpaceVRAM( )
- setStreamingFreeSpaceVRAM( int )
- getStreamingUsageLimitRAM( )
- setStreamingUsageLimitRAM( int )
- getStreamingUsageLimitVRAM( )
- setStreamingUsageLimitVRAM( int )
- getMaterialsQuality( )
- setMaterialsQuality( Render::MATERIALS_QUALITY )
- getEnvironmentHazeScreenSpaceGlobalIlluminationDistanceMax( )
- setEnvironmentHazeScreenSpaceGlobalIlluminationDistanceMax( float )
- getEnvironmentHazeScreenSpaceGlobalIlluminationDistanceMin( )
- setEnvironmentHazeScreenSpaceGlobalIlluminationDistanceMin( float )
- memoryClear( )
- setMultithreaded( bool )
- isMultithreaded( )
- setMultithreadedEditor( bool )
- isMultithreadedEditor( )
- setQuadroSync( bool )
- isQuadroSync( )
- isTAACatmullResamplingSharpness( )
- setTAACatmullResamplingSharpness( float )
Renderer Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
getAllSurfaces( Vector <Renderer::RenderSurface> & ) | Removed. |
renderMeshStatic( const Ptr<MeshStatic> &, const Ptr<Material> &, const char *, const Math::Mat4 &, const Ptr<Camera> & ) | Removed. Use renderMesh( const Ptr<MeshRender> &, const Ptr<Material> &, const char *, const Math::Mat4 &, const Ptr<Camera> & ) instead. |
New Functions
Shader Class#
StructuredBuffer Class#
SystemInfo Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
getSystemInfo( ) | Removed. |
getSystemMemory( ) | Removed. |
getCPUCount( ) | Removed. |
getGPUInfo( int ) | Removed. |
getGPUName( const char * ) | Removed. |
getGPUName( int ) | Removed. |
New Functions
- GPU_VENDOR_UNKNOWN
- GPU_VENDOR_AMD
- GPU_VENDOR_NVIDIA
- GPU_VENDOR_INTEL
- GPU_VENDOR_ARM
- GPU_VENDOR_APPLE
- GPU_VENDOR_IMGTEC
- GPU_VENDOR_QUALCOMM
- GPU_TYPE_DISCRETE
- GPU_TYPE_INTEGRATED
- GPU_TYPE_OTHER
- GPU_TYPE_UNSUPPORTED
- PLATFORM_TYPE_WINDOWS
- PLATFORM_TYPE_LINUX
- PLATFORM_TYPE_XBOX_SERIES_S
- PLATFORM_TYPE_XBOX_SERIES_X
- PLATFORM_TYPE_PS5
- getPlatformType( )
- getGPUMemoryFree( )
- getGPUDriver( int )
- getGPUVendorName( int )
- getGPUDescription( int )
- getGPULuid( int )
- getGPUDeviceID( int )
- getGPUVendor( int )
- getGPUType( int )
- findGPUByDeviceID( unsigned int )
- findGPUByLuid( unsigned long long )
- getGPUActive( )
- logInfo( )
- getCPUCores( )
- getMemoryFree( )
- getMemoryFreeCommitted( )
- getMemoryTotal( )
- getMemoryTotalCommitted( )
- getMemoryUsage( )
- getMemoryUsageCommitted( )
- getEngineInfo( )
- getOSInfo( )
TerrainDetail Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
setMaterialPath( const char * ) | Renamed as setMaterialFilePath( const char * ). |
getMaterialPath( ) | Renamed as getMaterialFilePath( ). |
Texture Class#
UGUID Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
getString () | Renamed as makeString (). |
getFileSystemString () | Removed. Use FileSystem::guidToPath (const UGUID &guid) instead. |
setFileSystemString (const char* str) | Removed. Use FileSystem::pathToGuid (const char* str) instead. |
get () | Removed. |
hashLong( ) | Removed. |
New Functions
VR Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
resetZeroPose( ) | Return value changed. |
New Functions
- API_OPENXR
- RUNTIME_TYPE_UNKNOWN
- RUNTIME_TYPE_NULL
- RUNTIME_TYPE_STEAMVR
- RUNTIME_TYPE_OCULUS
- RUNTIME_TYPE_VARJO
- RUNTIME_TYPE_WMR
- DEBUG_MODE_DISABLED
- DEBUG_MODE_ENABLED
- DEBUG_MODE_ENABLED_BREAK_ON_ERROR
- fadeGrid( float, bool )
- fadeToColor( float, const Math::vec4 &, bool )
- isSteamVRDashboardActive( )
- hasFeatureGetAudioDevice( )
- hasFeatureFadeGrid( )
- hasFeatureFadeToColor( )
- hasFeatureSupportForRenderModel( )
- getInputRuntimeType( )
- getInputRuntimeName( )
- getDebugMode( )
- setDebugMode( VR::DEBUG_MODE )
- getPlayerIModelview( )
- getPlayerModelview( )
- getPlayerWorldTransform( )
- hasFeatureHandTracking( )
- isHandTrackingOffsetSupported( )
VRMixedReality Class#
WidgetCanvas Class#
WidgetEditLine Class#
WidgetEditText Class#
World Class#
WorldClutter Class#
Xml Class#
Syncker::Manager Class#
Syncker::Master Class#
UNIGINE 2.18.1 | UNIGINE 2.19 |
---|---|
getSlaveView( int, int ) | Removed. |
setSlavePlayer( int, const Ptr<Player> & ) | Removed. Use setCustomPlayer( const char *, const Ptr<Player> & ) instead. |
setSlavePlayer( const char *, const Ptr<Player> & ) | Removed. Use setCustomPlayer( const char *, const Ptr<Player> & ) instead. |