API Migration
Major Changes
- Added a EnginePtr class.
- Added a EngineEditor class.
- Added a new FieldHeight class.
- Added a new FieldShoreline class.
- Added a new Geometry class to C++ and C#.
- The UNIGINE_API macro has been changed to UNIGINE_EXPORT.
Added new methods to the math-related classes. Please check each class API for the details.
App Class
Body Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| setContactCallback() | Changed type of the argument. |
| setFrozenCallback() | Changed type of the argument. |
| setPositionCallback() | Changed type of the argument. |
Camera Class
New Functions
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getDirectionFromScreen() | Changed set of arguments. |
| getProjectionFromScreen() | Changed set of arguments. |
New Functions
Console Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| addCommand() | Removed. |
DecalMesh Class
DecalOrtho Class
DecalProj Class
Editor Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| addNode() | Added the runtime flag. |
| get() | Removed. |
| call() | All call() functions have been removed. |
| createTerrainMask() | Removed. |
| loadMesh() | Removed. |
| saveMesh() | Removed. |
| createTerrainIndex() | Removed. |
| createTerrainMask() | Removed. |
New Functions
EditorLogic Class
Ellipsoid Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getENUTangentPoint | Changed the set of arguments. |
| getENUSurfacePoint | Changed the set of arguments. |
New Functions
Engine Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| main() | Added SystemLogic, EditorLogic and WorldLogic functionality. |
| runSystemFunction() | Added runSystemFunction() methods with the different set of arguments. |
| runEditorunction() | Added runEditorFunction() methods with the different set of arguments. |
| runWorldFunction() | Added runWorldFunction() methods with the different set of arguments. |
New Functions
- getRenderTime()
- getVideoApp()
- getMessage()
- removeWorldLogic()
- getSoundApp()
- dialogMessage()
- getSystemScript()
- addSystemLogic()
- getInterfaceTime()
- message()
- getNumEditorLogics()
- getControls()
- getSystemScript()
- getArg()
- getNumSystemLogics()
- getExternDefines()
- getHomePath()
- getWorldLogic()
- getEditorLogic()
- getNumDataPaths()
- getUpdateTime()
- getExternDefines()
- getGui()
- dialogError()
- error()
- getDataPath()
- getNumPluginPaths()
- dialogMessage()
- getSavePath()
- getAppPath()
- getEditorScript()
- getPluginPath()
- getSystemLogic()
- removeSystemLogic()
- removeEditorLogic()
- isMainThread()
- addEditorLogic()
- getEditorCache()
- getTotalTime()
- getSoundApp()
- getSystemCache()
- getNumWorldLogics()
- getNumPluginPaths()
- getVideoApp()
- addWorldLogic()
ExternClass Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| addFunction() | Changed type of the name argument. |
FieldAnimation Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| setScale() | Renamed setAnimationScale(). |
| getScale() | Renamed getAnimationScale(). |
FileSystem Class
GeodeticPivot Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getGeodetic() | Removed. |
New Functions
- STATUS_FLAT
- STATUS_CURVED
- STATUS_NEED_UPDATE
- ORIGIN_BASIS_LOCAL
- ORIGIN_BASIS_NED
- ORIGIN_BASIS_ENU
- saveRegionTexture()
- loadRegionTexture()
- getStatus()
- getRegionTextureName()
- clearTopology()
- setRegionTexture()
- setOriginBasis()
- getRegionTextureImage()
- getRegionHeight()
- setRegionTextureName()
- setRegionTextureResolution()
- setRegionWidth()
- getRegionTextureResolution()
- setRegionTextureImage()
- setRegionHeight()
- updateTopology()
- getRegionWidth()
- getOriginBasis()
- getRegionTexture()
Interpreter Class
Now the entities created via the Interpreter class (definitions, libraries, variables, functions, classes) can be grouped together if they have the same group argument. The argument has been added via:
New Functions
Image Class
Joint Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| setBrokenCallback() | Changed type of the argument. |
LightEnvironmentProbe Class
Material Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getAlphaTest() | Removed. |
| setAlphaTest() | Removed. |
New Functions
- MATERIAL_PARAMETER_COMBINER()
- MATERIAL_TRANSPARENT_ALPHA_TEST()
- isDeferred()
- isAlphaTest()
- getState()
- setState()
- isWater()
- isForward()
- STATE_INT
- TEXTURE_GBUFFER_ALBEDO
- TEXTURE_GBUFFER_SHADING
- TEXTURE_GBUFFER_NORMAL
- TEXTURE_GBUFFER_VELOCITY
- TEXTURE_GBUFFER_MATERIAL_MASK
- TEXTURE_GBUFFER_LIGHTMAP
- TEXTURE_AUXILIARY
- TEXTURE_REFRACTION
- TEXTURE_SSAO
- TEXTURE_SSR
- TEXTURE_SSR_DEPTH
- TEXTURE_SCREEN_COLOR
- TEXTURE_SCREEN_COLOR_OLD
- TEXTURE_CURRENT_DEPTH
- TEXTURE_OPACITY_DEPTH
- TEXTURE_OPACITY_SCREEN
- TEXTURE_TRANSPARENT_ENVIRONMENT_PROBE
- TEXTURE_REFLECTION_CUBE
- TEXTURE_SCATTERING_SKY_LUT
- TEXTURE_SCATTERING_GROUND_LUT
- TEXTURE_WBUFFER_CONSTANT_ID
- TEXTURE_WBUFFER_DIFFUSE
- TEXTURE_WBUFFER_NORMAL
- TEXTURE_WBUFFER_WATER
- TEXTURE_WBUFFER_FOG
- TEXTURE_WBUFFER_WU_MASK
- TEXTURE_FIELD_HEIGHT_ARRAY
- TEXTURE_FIELD_SHORELINE_ARRAY
- TEXTURE_DECAL_DEPTH
- TEXTURE_DECAL_ALBEDO
- TEXTURE_DECAL_NORMAL
- TEXTURE_DECAL_SHADING
- TEXTURE_GEODETIC_TOPOLOGY
Node Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| clearTopology() | Removed. |
| updateTopology() | Removed. |
New Functions
- removeVariable()
- hasVariable()
- getVariable()
- hasVariable()
- getVariable()
- setVariable()
- setVariable()
- worldTranslate()
- worldScale()
- toLocal()
- worldLookAt()
- rotate()
- getRootNode()
- worldRotate()
- findNode()
- worldLookAt()
- toWorld()
- scale()
- translate()
- getWorldUp()
- getWorldLeft()
- getWorldForward()
- getWorldBack()
- getWorldRight()
- getWorldDown()
- getTypeName()
- getTypeId()
- FIELD_SHORELINE()
NodeTrigger Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| setEnabledCallback() | Changed type of the argument. |
| setPositionCallback() | Changed type of the argument. |
New Functions
ObjectBillboards Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getPosition() | Renamed getBillboardPosition(). |
| setPosition() | Renamed setBillboardPosition(). |
ObjectDynamic Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| setVertexUChar() | Changed set of arguments. |
ObjectMeshClutter Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| setRotation() | Renamed setMeshesRotation(). |
| getRotationMean() | Renamed getMeshesRotationMean(). |
| getRotationSpread() | Renamed getMeshesRotationSpread(). |
ObjectMeshStatic Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| clearTopology() | Removed. |
| updateTopology() | Removed. |
ObjectParticles Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getBoundSphereParticles() | Removed. |
| setRotation() | Renamed setParticlesRotation(). |
| getRotationMean() | Renamed getParticlesRotationMean(). |
| getRotationSpread() | Renamed getParticlesRotationSpread(). |
New Functions
- setProceduralTextureResolution()
- getProceduralPositioning()
- isProceduralRendering()
- setProceduralRendering()
- getProceduralParenting()
- setProceduralParenting()
- setProceduralPositioning()
- getProceduralTextureResolution()
- getMaxWarmingTime
- cast
- setMaxWarmingTime
- getWorldBoundBoxParticles
- getBoundBoxSimulation
- cast
ObjectTerrain Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getDiffuseTexture() | Removed. |
| getDiffuseTextureArray() | Removed. |
| setDiffuseTextureArrayName() | Removed. |
| getDiffuseTextureArrayName() | Removed. |
| setDiffuseTextureImage() | Removed. |
| getDiffuseTextureImage() | Removed. |
| setDiffuseTextureName() | Removed. |
| getDiffuseTextureName() | Removed. |
| getIndexTexture() | Removed. |
| setIndexTextureImage() | Removed. |
| getIndexTextureImage() | Removed. |
| setIndexTextureName() | Removed. |
| setMaterialDiffuseScale() | Removed. |
| getMaterialDiffuseScale() | Removed. |
| setMaterialDiffuseTextureName() | Removed. |
| getMaterialDiffuseTextureName() | Removed. |
| setMaterialMaskBase() | Removed. |
| getMaterialMaskBase() | Removed. |
| setMaterialParent() | Removed. |
| getMaterialParent() | Removed. |
| setMaterialSpecularScale() | Removed. |
| getMaterialSpecularScale() | Removed. |
| setMaterialSpecularTextureName() | Removed. |
| getMaterialSpecularTextureName() | Removed. |
| setNumMaterials() | Removed. |
| getPoint() | Removed. |
| getNumMaterials() | Added a new layer argument. |
| getSpecularTextureArray() | Removed. |
| setSpecularTextureArrayName() | Removed. |
| getSpecularTextureArrayName() | Removed. |
| getSurfaceDiffuseTexture() | Removed. |
| setSurfaceDiffuseTextureImage() | Removed. |
| getSurfaceDiffuseTextureImage() | Removed. |
| setSurfaceDiffuseTextureName() | Removed. |
| getSurfaceDiffuseTextureName() | Removed. |
| getSurfaceIndexTexture() | Removed. |
| setSurfaceIndexTextureImage() | Removed. |
| getSurfaceIndexTextureImage() | Removed. |
| setSurfaceIndexTextureName() | Removed. |
| getSurfaceIndexTextureName() | Removed. |
| setMaterialMaskThreshold() | Changed set of arguments. |
| getMaterialMaskThreshold() | Changed set of arguments. |
| setMaterialMaskValue() | Changed set of arguments. |
| getMaterialMaskValue() | Changed set of arguments. |
| setMaterialMaskWidth() | Changed set of arguments. |
| getMaterialMaskWidth() | Changed set of arguments. |
| setMaterialName() | Changed set of arguments. |
| getMaterialName() | Changed set of arguments. |
| setMaterialNormalScale() | Changed set of arguments. |
| getMaterialNormalScale() | Changed set of arguments. |
| setMaterialNormalTextureName() | Changed set of arguments. |
| getMaterialNormalTextureName() | Changed set of arguments. |
| setMaterialOverlap() | Changed set of arguments. |
| getMaterialOverlap() | Changed set of arguments. |
| setMaterialTransform() | Changed set of arguments. |
| getMaterialTransform() | Changed set of arguments. |
| addMaterial() | Changed set of arguments. |
| removeMaterial() | Changed set of arguments. |
| deleteTopology() | Removed. |
| loadTopology() | Removed. |
| saveTopology() | Removed. |
New Functions
- setMaterialNormalScale_int_int_float_void
- setAlbedoTextureName_cstr_void
- setAlbedoTextureImage_Image_int
- getNumLayers
- getSurfaceAlbedoTextureName
- setMaterialDetail
- getMaterialMaskValue
- setMaterialName
- allocateLayers
- getLayerEnabled
- getAlbedoTextureImage
- removeMaterial
- getSurfaceAlbedoTexture
- getMaterialNormalScale
- setSurfaceAlbedoTextureName
- setMaterialRoughnessTextureName
- setMaterialRoughnessScale
- addMaterial
- swapLayer
- getMaterialLayer
- cloneMaterial
- getMaterialRoughnessScale
- getMaterialAlbedoScale
- getMaterialRoughnessTextureName
- getMaterialAlbedoColor
- allocateMaterials
- getLayerName
- getAlbedoTextureArrayName
- getMaterialNormalTextureName
- getAlbedoTextureName
- setMaterialOverlap
- setLayerEnabled
- getMaterialHeightTextureName
- getMaterialMaskWidth
- getMaterialAlbedoTextureName
- setMaterialAlbedoColor
- removeLayer
- setMaterialMaskValue
- setMaterialHeightTextureName
- setMaterialAlbedoScale
- getHeightTextureArrayName
- getSurfaceAlbedoTextureImage
- getMaterialDetail
- getAlbedoTexture
- setSurfaceAlbedoTextureImage
- getNumAllMaterials
- setMaterialMaskWidth
- cast
- setMaterialMaskThreshold
- getTopologyData
- setMaterialAlbedoTextureName
- swapMaterial
- getMaterialName
- cast
- getHeightTextureArray
- setHeightTextureArrayName
- getMaterialRoughness
- setMaterialTransform
- getMaterialEnabled
- setMaterialEnabled
- getWorldHeight_Vec3_float
- getMaterialMaskThreshold
- setLayerName
- getAlbedoTextureArray
- getLocalPoint
- addLayer
- setAlbedoTextureArrayName
- setMaterialRoughness
- cloneLayer
- setMaterialLayer
ObjectVolumeProj Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| setRotation() | Renamed setVolumeRotation(). |
| getRotation() | Renamed getVolumeRotation(). |
ObjectWaterGlobal Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getWaterProceduralLevel() | Removed. |
| getIntersection() | Removed. Added new getWorldIntersection() method. |
New Functions
PhysicalNoise Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| setScale() | Renamed setNoiseScale(). |
| getScale() | Renamed getNoiseScale(). |
Player Class
Plugin Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| initWorld() | Removed. |
| shutdownWorld() | Removed. |
| updateWorld() | Removed. |
| flushWorld() | Removed. |
PhysicalTrigger Class
Ptr Class
Render Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| setShadowShaftsAttenuation() | Removed. |
| getReflection() | Removed. |
| getShadowShaftsAttenuation() | Removed. |
| setBokehColor() | Removed. |
| getBokehColor() | Removed. |
| setBokehEnabled() | Removed. |
| isBokehEnabled() | Removed. |
| setBokehFarPower() | Removed. |
| getBokehFarPower() | Removed. |
| setBokehFarSize() | Removed. |
| getBokehFarSize() | Removed. |
| setBokehNearPower() | Removed. |
| getBokehNearPower() | Removed. |
| setBokehNearSize() | Removed. |
| getBokehNearSize() | Removed. |
| setBokehScale() | Removed. |
| getBokehScale() | Removed. |
| setBokehTextureName() | Removed. |
| getBokehTextureName() | Removed. |
| setBokehThreshold() | Removed. |
| getBokehThreshold() | Removed. |
| setDOFFarFocalScale() | Removed. |
| getDOFFarFocalScale() | Removed. |
| setDOFFarFocalRange() | Removed. |
| getDOFFarFocalRange() | Removed. |
| setDOFFarFocalPower() | Removed. |
| getDOFFarFocalPower()() | Removed. |
| setDOFFarBlurPower() | Removed. |
| getDOFFarBlurPower() | Removed. |
| setDOFFarBlurRadius() | Removed. |
| getDOFFarBlurRadius() | Removed. |
| getDOFFarBlurRange() | Removed. |
| setDOFNearBlurPower() | Removed. |
| getDOFNearBlurPower() | Removed. |
| setDOFNearBlurRadius() | Removed. |
| getDOFNearBlurRadius() | Removed. |
| getDOFNearBlurRadius() | Removed. |
| setDOFNearBlurRadius() | Removed. |
| setDOFNearBlurRange() | Removed. |
| getDOFNearBlurRange() | Removed. |
| setDOFNearFocalPower() | Removed. |
| getDOFNearFocalPower() | Removed. |
| setDOFNearFocalRange() | Removed. |
| getDOFNearFocalRange() | Removed. |
| setDOFNearFocalScale() | Removed. |
| getDOFNearFocalScale() | Removed. |
| renderImageCube() | Added the hdr and local space flags. |
| setExposureBright() | Removed. |
| getExposureBright() | Removed. |
| setShadowShaftsMaterialMask() | Removed. |
| getShadowShaftsMaterialMask() | Removed. |
| renderImageCube() | Removed. |
New Functions
- setSSREnabled()
- getSSRStretching()
- isSSRFarEnabled()
- setSSRFarDistanceScale()
- getSSRNearDistanceScale()
- isDepthZeroToOne()
- getSSRResolution()
- setSSRResolution()
- setSSRScale()
- getSSRFarQuality()
- isSSRNormalThreshold()
- setSSRNormalThreshold()
- setSSRNearDistanceScale()
- setSSRFarQuality()
- isSSRDepthThreshold()
- getSSRNearQuality()
- isSSRNearEnabled()
- setSSRFarEnabled()
- setSSRNearQuality()
- isSSREnabled()
- setSSRDepthThreshold()
- setSSRStretching()
- setSSRRoughnessQuality()
- getSSRRoughnessQuality()
- setSSRNearEnabled()
- createMipmapsCubeGGX()
- getSSRFarDistanceScale()
- getDOFNearDistance()
- createShorelineDistanceField()
- setDOFNearFocalOffset()
- setDOFNearDistance_float_void()
- setSkyRotation()
- getDOFBlur()
- getDOFNearFocalOffset()
- setDOFBlur()
- getDOFChromaticAberration()
- setDOFChromaticAberration()
- getDOFFarDistance_float()
- setDOFFarDistance()
- setDOFFarFocalOffset()
- getDOFFarFocalOffset()
- setBloomScale()
- setBloomPower()
- getBloomPower()
- getDirtScale()
- setDirtScale()
- getBloomScale()
- setTAAFrameCount()
- setTAAVelocityThreshold()
- getTAAMinFrameCount()
- getTAAPreserveDetails()
- setTAAMaxFrameCount()
- getTAAVelocityThreshold()
- setTAAMinFrameCount()
- setTAAPreserveDetails()
- getTAAMaxFrameCount()
- getTAAFrameCount()
- getSkyRotation()
Renderer Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getAlphaTest() | Removed. |
| setAlphaTest() | Removed. |
RenderState Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getDeferredSpecularTexture() | Removed. |
| getDeferredTextureDecalMask() | Removed. |
| getDeferredVelocityTexture() | Removed. |
| getDeferredDepthTexture() | Removed. |
| getDeferredDiffuseTexture | Removed. |
| getDeferredReflectionTexture() | Removed. |
| getDeferredLightTexture | Removed. |
| getDeferredOcclusionTexture | Removed. |
| getDeferredNormalTexture | Removed. |
New Functions
Stream Class
Texture Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getD3D11UnorderedAccessView() | Added the r32_typeless argument. |
New Functions
TextureRender Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| setFace() | Removed. |
| setLayer() | Removed. |
| getLayer() | Removed. |
| disable() | Removed the discard flags argument. |
| getFace() | Removed. |
New Functions
UserInterface Class
Variable Class
Viewport Class
Visualizer Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| renderPoint3D() | Removed. |
| renderBillboard3D() | Removed. |
| getProjection() | Removed. |
| getModelview() | Removed. |
| getScale() | Removed. |
| renderTextureHandler() | Removed. |
| renderDirection() | Removed. |
| setProjection() | Removed. |
| setModelview() | Removed. |
WidgetClass Class
World Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| call() | All call() functions have been removed. |
| get() | Removed. |
WorldClutter Class
| UNIGINE 2.2.1 | UNIGINE 2.3 |
|---|---|
| getRotationSpread() | Renamed getNodesRotationSpread(). |
| getRotationMean() | Renamed getNodesRotationMean(). |
| setRotation() | Renamed setNodesRotation(). |
WorldTrigger Class
Last update: 2017-07-03
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)