API Migration
Major Changes
- Added new RenderContext class.
- Added new RenderEnvironmentPreset class.
- Added new AsyncQueue class.
- Added new TerrainGlobalDetail class.
- Added new TerrainGlobalLod class.
- Added new TerrainGlobalLods class.
- Added new TerrainGlobalLodHeight class.
- Added new UGUID class.
App Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| initD3D11_void_void_void_int_int() | Set of arguments changed. |
| initGL() | Set of arguments changed. |
New Functions
ControlsApp Class
Decal Class
Dir Class
EditorLogic Class
Ellipsoid Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| toGeodetic() | Added need_alt argument. |
Engine Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| initD3D11() | Set of arguments changed. |
| initGL() | Set of arguments changed. |
New Functions
FieldHeight Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| setImageTexture() | Removed. Use setTexture() instead. |
| getImageTexture() | Removed. Use getTexture() instead. |
| setImageTextureImage() | Removed. Use setTextureImage() instead. |
| getImageTextureImage() | Removed. Use getTextureImage() instead. |
| setImageTextureName() | Removed. Use setTexturePath() instead. |
| getImageTextureName() | Removed. Use getTexturePath() instead. |
New Functions
FieldShoreline Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| setImageTexture() | Removed. Use setTexture() instead. |
| getImageTexture() | Removed. Use getTexture() instead. |
| setImageTextureImage() | Removed. Use setTextureImage() instead. |
| getImageTextureImage() | Removed. Use getTextureImage() instead. |
| setImageTextureName() | Removed. Use setTexturePath() instead. |
| getImageTextureName() | Removed. Use getTexturePath() instead. |
New Functions
FieldWeather Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| setImageTexture() | Removed. Use setTexture() instead. |
| getImageTexture() | Removed. Use getTexture() instead. |
| setImageTextureImage() | Removed. Use setTextureImage() instead. |
| getImageTextureImage() | Removed. Use getTextureImage() instead. |
| setImageTextureName() | Removed. Use setTexturePath() instead. |
| getImageTextureName() | Removed. Use getTexturePath() instead. |
New Functions
Filesystem Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| getImage() | Removed. Use AsyncQueue::getImage() instead. |
| isFile() | Set of arguments changed. |
| getFileName() | Set of arguments changed. |
| addKnownFile() | Set of arguments changed. |
| isKnownFile() | Set of arguments changed. |
| isPackageFile() | Set of arguments changed. |
| getMesh() | Removed. Use AsyncQueue::getMesh() instead. |
| setMTime() | Set of arguments changed. |
| getMTime() | Set of arguments changed. |
| getNumQueuedData() | Removed. |
| getNumQueuedFiles() | Removed. Use AsyncQueue::getNumQueuedFiles() instead. |
| getNumQueuedImages() | Removed. Use AsyncQueue::getNumQueuedImages() instead. |
| getNumQueuedMeshes() | Removed. Use AsyncQueue::getNumQueuedMeshes() instead. |
| getNumQueuedResources() | Removed. Use AsyncQueue::getNumQueuedResources() instead. |
| getTotalTime() | Removed. Use AsyncQueue::getTotalTime() instead. |
| checkFile() | Removed. Use AsyncQueue::checkFile() instead. |
| checkImage() | Removed. Use AsyncQueue::checkImage() instead. |
| checkMesh() | Removed. Use AsyncQueue::checkMesh() instead. |
| forceFile() | Removed. Use AsyncQueue::forceFile() instead. |
| forceImage() | Removed. Use AsyncQueue::forceImage() instead. |
| forceMesh() | Removed. Use AsyncQueue::forceMesh() instead. |
| loadFile() | Removed. Use AsyncQueue::loadFile() instead. |
| loadImage() | Removed. Use AsyncQueue::loadImage() instead. |
| loadMesh() | Removed. Use AsyncQueue::loadMesh() instead. |
| removeFile() | Removed. Use AsyncQueue::removeFile() instead. |
| removeImage() | Removed. Use AsyncQueue::removeImage() instead. |
| removeMesh() | Removed. Use AsyncQueue::removeMesh() instead. |
| validateFile() | Removed. Use isCacheFile() instead. |
| getPackageFileName() | Set of arguments changed. |
New Functions
- isBlobFile()
- addBlobFile()
- removeBlobFile()
- isCacheFile()
- addCacheFile()
- removeCacheFile()
- isFile()
- isKnownFile()
- addKnownFile()
- renameKnownFile()
- renameKnownFile()
- renameKnownFile()
- renameKnownFile()
- removeKnownFile()
- removeKnownFile()
- isPackageFile()
- isPackageFile()
- isPackageFile()
- getFileName()
- getRelativeFileName()
- getRelativeFileName()
- resolveName()
- resolveName()
- setGUID()
- getGUID()
- isGUID()
- saveGUIDs()
- loadGUIDs()
- clearGUIDs()
GeodeticPivot Class
Image Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| set2DSmooth() | Removed. |
| get2DSmooth() | Removed. |
| set3DSmooth() | Removed. |
New Functions
LightEnvironmentProbe Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| setImageTexture() | Removed. Use setTexture() instead. |
| getImageTexture() | Removed. Use getTexture() instead. |
| setImageTextureImage() | Removed. Use setTextureImage() instead. |
| getImageTextureImage() | Removed. Use getTextureImage() instead. |
| setImageTextureName() | Removed. Use setTexturePath() instead. |
| getImageTextureName() | Removed. Use getTexturePath() instead. |
New Functions
LightOmni Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| setImageTexture() | Removed. Use setTexture() instead. |
| getImageTexture() | Removed. Use getTexture() instead. |
| setImageTextureImage() | Removed. Use setTextureImage() instead. |
| getImageTextureImage() | Removed. Use getTextureImage() instead. |
| setImageTextureName() | Removed. Use setTexturePath() instead. |
| getImageTextureName() | Removed. Use getTexturePath() instead. |
New Functions
LightProj Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| setImageTexture() | Removed. Use setTexture() instead. |
| getImageTexture() | Removed. Use getTexture() instead. |
| setImageTextureImage() | Removed. Use setTextureImage() instead. |
| getImageTextureImage() | Removed. Use getTextureImage() instead. |
| setImageTextureName() | Removed. Use setTexturePath() instead. |
| getImageTextureName() | Removed. Use getTexturePath() instead. |
New Functions
Material Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| setImageTexture() | Removed. Use setTexture() instead. |
| getImageTexture() | Removed. Use getTexture() instead. |
| setImageTextureFlags() | Removed. Use setTextureFlags() instead. |
| getImageTextureFlags() | Removed. Use getTextureFlags() instead. |
| setImageTextureImage() | Removed. Use setTextureImage() instead. |
| getImageTextureImage() | Removed. Use getTextureImage() instead. |
| setImageTextureName() | Removed. Use setTexturePath() instead. |
| getImageTextureName() | Removed. Use getTexturePath() instead. |
| getCompare() | Removed. |
| getParameterSliderLog10() | Removed. |
| loadWorld() | Removed. |
| saveWorld() | Removed. |
New Functions
- isBase()
- isEngine()
- isManual()
- isInternal()
- isAutoSave()
- isNodeSupported()
- isNodeTypeSupported()
- canSave()
- canRenderNode()
- hasOverrides()
- getBaseMaterial()
- getGUID()
- setName()
- setParent()
- isParent()
- setPath()
- getPath()
- setParameter()
- getParameter()
- checkParameterConditions()
- resetParameter()
- checkStateConditions()
- resetState()
- setTexture()
- getTexture()
- checkTextureConditions()
- resetTexture()
- setTextureFlags()
- getTextureFlags()
- setTextureImage()
- getTextureImage()
- setTexturePath()
- setTexturePath()
- getTexturePath()
- getTexturePath()
- clone()
- clone()
- clone()
- inherit()
- inherit()
- inherit()
- load()
- load()
- loadXml()
- save()
- save()
- saveXml()
- reload()
- reloadShaders()
Materials Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| isLibrary() | Removed. |
| isLibraryEditable() | Removed. |
| getNumLibraries() | Removed. |
| getNumWorldLibraries() | Removed. |
| getLibraryName() | Removed. |
| getWorldLibraryName() | Removed. |
| addWorldLibrary() | Removed. |
| findLibrary() | Removed. |
| findLibraryMaterial() | Removed. |
| findMaterialLibrary() | Removed. |
| getNumMaterials() | Set of arguments changed. |
| getMaterial() | Set of arguments changed. |
| getMaterialName() | Set of arguments changed. |
| cloneMaterial() | Removed. |
| inheritMaterial() | Removed. |
| moveMaterial() | Removed. |
| removeMaterial() | Set of arguments changed. |
| replaceMaterial() | Removed. |
| clear() | Removed. |
| create() | Removed. |
| load() | Removed. |
| reload() | Removed. |
| save() | Removed. |
| removeWorldLibrary() | Removed. |
New Functions
Node Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| canApplyToPrefab() | Removed. |
| canAddChild() | Removed. |
| getLinkedHierarchy() | Removed. |
| getLinkedRoot() | Removed. |
| isPrefabInstance() | Removed. |
| isPrefabInstanceChanged() | Removed. |
| isPrefabMissing() | Removed. |
| setPrefabName() | Removed. |
| getPrefabName() | Removed. |
| getPrefabPropertyNames() | Removed. |
| isPrefabPropertyOverridden() | Removed. |
| freezePrefabLink() | Removed. |
| hasOverridenPrefabProperties() | Removed. |
| hasPrefabLink() | Removed. |
| hasPrefabName() | Removed. |
| revertPrefabProperty() | Removed. |
New Functions
NodeReference Class
Object Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| getSurfacePrefabPropertyNames() | Removed. |
| isSurfacePrefabPropertyOverridden() | Removed. |
| revertSurfacePrefabProperty() | Removed. |
New Functions
ObjectDynamic Class
ObjectExtern Class
ObjectGui Class
ObjectGuiMesh Class
ObjectMeshStatic Class
ObjectTerrainGlobal Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| setAlbedoLodClearDistance() | Removed. |
| getAlbedoLodClearDistance() | Removed. |
| setAlbedoLodEnabled() | Removed. |
| getAlbedoLodEnabled() | Removed. |
| setAlbedoLodLoadDistance() | Removed. |
| getAlbedoLodLoadDistance() | Removed. |
| setAlbedoLodPath() | Removed. |
| getAlbedoLodPath() | Removed. |
| setAlbedoLodTileDensity() | Removed. |
| getAlbedoLodTileDensity() | Removed. |
| getAlbedoLodTileset() | Removed. |
| setAlbedoLodViewportMask() | Removed. |
| getAlbedoLodViewportMask() | Removed. |
| setAlbedoLodVisibleDistance() | Removed. |
| getAlbedoLodVisibleDistance() | Removed. |
| getAlbedoNumLods() | Removed. |
| getAlbedoVideoMemoryUsage() | Removed. |
| setHeightLodClearDistance() | Removed. |
| getHeightLodClearDistance() | Removed. |
| setHeightLodCollision() | Removed. |
| getHeightLodCollision() | Removed. |
| setHeightLodCollisionMask() | Removed. |
| getHeightLodCollisionMask() | Removed. |
| setHeightLodEnabled() | Removed. |
| getHeightLodEnabled() | Removed. |
| setHeightLodIntersection() | Removed. |
| getHeightLodIntersection() | Removed. |
| setHeightLodIntersectionMask() | Removed. |
| getHeightLodIntersectionMask() | Removed. |
| setHeightLodLoadDistance() | Removed. |
| getHeightLodLoadDistance() | Removed. |
| setHeightLodPath() | Removed. |
| getHeightLodPath() | Removed. |
| setHeightLodTileDensity() | Removed. |
| getHeightLodTileDensity() | Removed. |
| getHeightLodTileset() | Removed. |
| setHeightLodViewportMask() | Removed. |
| getHeightLodViewportMask() | Removed. |
| setHeightLodVisibleDistance() | Removed. |
| getHeightLodVisibleDistance() | Removed. |
| getHeightNumLods() | Removed. |
| getHeightVideoMemoryUsage() | Removed. |
| setNormalLodClearDistance() | Removed. |
| getNormalLodClearDistance() | Removed. |
| setNormalLodEnabled() | Removed. |
| getNormalLodEnabled() | Removed. |
| setNormalLodLoadDistance() | Removed. |
| getNormalLodLoadDistance() | Removed. |
| setNormalLodPath() | Removed. |
| getNormalLodPath() | Removed. |
| setNormalLodTileDensity() | Removed. |
| getNormalLodTileDensity() | Removed. |
| getNormalLodTileset() | Removed. |
| setNormalLodViewportMask() | Removed. |
| getNormalLodViewportMask() | Removed. |
| setNormalLodVisibleDistance() | Removed. |
| getNormalLodVisibleDistance() | Removed. |
| getNormalNumLods() | Removed. |
| getNormalVideoMemoryUsage() | Removed. |
| addAlbedoLod() | Removed. |
| addHeightLod() | Removed. |
| addNormalLod() | Removed. |
| fetchAlbedoes() | Removed. |
| fetchHeights() | Removed. |
| fetchNormals() | Removed. |
| removeAlbedoLod() | Removed. |
| removeHeightLod() | Removed. |
| removeNormalLod() | Removed. |
New Functions
- clear()
- getAlbedoLods()
- getAlbedoTextureArray()
- setAlbedoTextureArrayName()
- getAlbedoTextureArrayName()
- addDetail()
- cloneDetail()
- getDetail()
- removeDetail()
- swapDetail()
- resizeDetails()
- getNumDetails()
- addMask()
- cloneMask()
- removeMask()
- swapMask()
- resizeMasks()
- replaceMasks()
- getNumMasks()
- getMaskLods()
- setMaskName()
- getMaskName()
- getHeightLods()
- getHeightTextureArray()
- setHeightTextureArrayName()
- getHeightTextureArrayName()
- getNormalLods()
- getNormalTextureArray()
- setNormalTextureArrayName()
- getNormalTextureArrayName()
Property Class
Properties Class
Render Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| setEnvironmentAmbientIntensity() | Removed. Use setAmbientIntensity() instead. |
| getEnvironmentAmbientIntensity() | Use:
|
| setEnvironmentHazeColor() | Removed. Use setHazeColor() instead. |
| getEnvironmentHazeColor() | Use:
|
| setEnvironmentHazeDensity() | Removed. Use setHazeDensity() instead. |
| getEnvironmentHazeDensity() | Use:
|
| setEnvironmentHazeMaxDistance() | Removed. Use setHazeMaxDistance() instead. |
| getEnvironmentHazeMaxDistance() | Use:
|
| setEnvironmentPresetIntensity() | Removed. Use setIntensity() instead. |
| getEnvironmentPresetIntensity() | Removed. Use getIntensity() instead. |
| setEnvironmentReflectionIntensity() | Removed. Use setReflectionIntensity() instead. |
| getEnvironmentReflectionIntensity() | Use:
|
| setEnvironmentScatteringBaseLUTName() | Removed. Use setScatteringBaseLUTName() instead. |
| getEnvironmentScatteringBaseLUTName() | Removed. Use getScatteringBaseLUTName() instead. |
| setEnvironmentScatteringGroundColor() | Removed. Use setScatteringGroundColor() instead. |
| getEnvironmentScatteringGroundColor() | Removed. Use getScatteringGroundColor() instead. |
| setEnvironmentScatteringGroundLUTName() | Removed. Use setScatteringGroundLUTName() instead. |
| getEnvironmentScatteringGroundLUTName() | Removed. Use getScatteringGroundLUTName() instead. |
| setEnvironmentScatteringLightColorLUTName() | Removed. Use setScatteringLightColorLUTName() instead. |
| getEnvironmentScatteringLightColorLUTName() | Removed. Use getScatteringLightColorLUTName() instead. |
| setEnvironmentScatteringMieLUTName() | Removed. Use setScatteringMieLUTName() instead. |
| getEnvironmentScatteringMieLUTName() | Removed. Use getScatteringMieLUTName() instead. |
| setEnvironmentSkyIntensity() | Removed. Use setSkyIntensity() instead. |
| getEnvironmentSkyIntensity() | Use:
|
| setEnvironmentTextureColor() | Removed. Use setTextureColor() instead. |
| getEnvironmentTextureColor() | Removed. Use getTextureColor() instead. |
| setEnvironmentTextureName() | Removed. Use setTextureName() instead. |
| getEnvironmentTextureName() | Removed. Use getTextureName() instead. |
New Functions
- setMaxFieldAnimations()
- getMaxFieldAnimations()
- setMaxFieldHeights()
- getMaxFieldHeights()
- setMaxFieldShorelines()
- getMaxFieldShorelines()
- setMaxFieldSpacers()
- getMaxFieldSpacers()
- setClearBufferMask()
- getClearBufferMask()
- setEnvironmentHazeGradient()
- getEnvironmentHazeGradient()
- getEnvironmentPreset()
Texture Class
Variable Class
Viewport Class
WidgetManipulator Class
World Class
Notice
Please be aware that the list of arguments for saveNode() and saveNodes() functions has changed the following way:
- saveNode(name, node, save_materials, binary) -> saveNode(name, node, binary)
- saveNodes(name, node, save_materials, binary) -> saveNodes(name, node, binary)
When calling these methods, you can set the binary flag to 1 by mistake, as a result you node(s) will be saved to a binary *.xml file, that cannot be read.
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| getAsyncNode() | Removed. Use AsyncQueue::getNode() instead. |
| getAsyncNodes() | Removed. Use AsyncQueue::getNodes() instead. |
| getNumQueuedNodes() | Removed. Use AsyncQueue::getNumQueuedNodes() instead. |
| getNumQueuedResources() | Removed. Use AsyncQueue::getNumQueuedResources() instead. |
| getTotalTime() | Removed. Use AsyncQueue::getTotalTime() instead. |
| checkAsyncNode() | Removed. Use AsyncQueue::checkNode() instead. |
| forceAsyncNode() | Removed. Use AsyncQueue::forceNode() instead. |
| loadAsyncNode() | Removed. Use AsyncQueue::loadNode() instead. |
| removeAsyncNode() | Removed. Use AsyncQueue::removeNode() instead. |
| loadNode() | Set of arguments changed. |
| saveNode() | Set of arguments changed. |
| saveNodes() | Set of arguments changed. |
| loadPrefab() | Removed. |
| savePrefab() | Removed. |
New Functions
WorldSplineGraph Class
| UNIGINE 2.5 | UNIGINE 2.6 |
|---|---|
| getNumPrefabNodes() | Removed. Use getNumSourceNodes() instead. |
| addPrefabNode() | Removed. Use addSourceNode() instead. |
| removePrefabNode() | Removed. Use removeSourceNode() instead. |
| assignSegmentPrefab() | Removed. Use assignSegmentSource() instead. |
| clearSegmentPrefab() | Removed. Use clearSegmentSource() instead. |
| setPrefabForwardAxis() | Removed. Use setSourceForwardAxis() instead. |
| getPrefabForwardAxis() | Removed. Use getSourceForwardAxis() instead. |
| getPrefabNodeName() | Removed. Use getSourceNodeName() instead. |
| getSegmentPrefabIndex() | Removed. Use getSegmentSourceIndex() instead. |
| getSegmentNodes() | Set of arguments changed. |
| setMaxVisibleDistance() | Removed. |
| getMaxVisibleDistance() | Removed. |
| setMinVisibleDistance() | Removed. |
| getMinVisibleDistance() | Removed. |
New Functions
Last update: 2017-10-20
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)