Script-facing composition module for live heightmap editing targets. 更多...
#include <HeightmapTargetModule.h>
Public 成员函数 | |
| Module_REG (HeightmapTargetModule) | |
| std::unique_ptr< procgen_editing::HeightmapTarget > | newTarget (std::string id, procgen::Heightmap *heightmap) const |
| Create an independently owned adapter over a borrowed heightmap. | |
| void | bind (editor::EditorSession *session, procgen_editing::HeightmapTarget *target) const |
| Bind borrowed target and session objects without taking ownership. @thread Owner-thread only. | |
| int | applyBrush (procgen::Heightmap *heightmap, float centerX, float centerY, float radius, float strength) const |
| Compatibility projection of the canonical structured brush result for scripts. | |
| graphics::Mesh * | newMesh (procgen::Heightmap *heightmap, float cellSize, float heightScale) const |
| Compatibility projection that creates a flat-shaded preview mesh. @thread Render-thread only. | |
| bool | updateMesh (graphics::Mesh *mesh, graphics::Graphics *graphics, procgen::Heightmap *heightmap, float cellSize, float heightScale) const |
| Compatibility projection that updates a flat-shaded preview mesh. @thread Render-thread only. | |
| graphics::Mesh * | newSmoothMesh (procgen::Heightmap *heightmap, float cellSize, float heightScale) const |
| Compatibility projection that creates a smooth-normal preview mesh. @thread Render-thread only. | |
| bool | updateSmoothMesh (graphics::Mesh *mesh, graphics::Graphics *graphics, procgen::Heightmap *heightmap, float cellSize, float heightScale) const |
| Compatibility projection that updates a smooth-normal preview mesh. @thread Render-thread only. | |
| Result< std::string > | encodeDocument (const procgen::Heightmap *heightmap, float spacingX, float spacingZ) const |
| Encode an editable heightmap as the versioned terrain editor JSON document. | |
| Result< void > | decodeDocument (std::string_view json, procgen::Heightmap *heightmap) const |
| Atomically replace a heightmap from a validated terrain editor JSON document. | |
Public 成员函数 继承自 eve::Module | |
| virtual | ~Module () |
| Module. | |
| virtual std::string | getName () const =0 |
| Returns the name. | |
详细描述
Script-facing composition module for live heightmap editing targets.
在文件 HeightmapTargetModule.h 第 28 行定义.
成员函数说明
◆ applyBrush()
| int eve::heightmap_target::HeightmapTargetModule::applyBrush | ( | procgen::Heightmap * | heightmap, |
| float | centerX, | ||
| float | centerY, | ||
| float | radius, | ||
| float | strength | ||
| ) | const |
Compatibility projection of the canonical structured brush result for scripts.
在文件 HeightmapTargetModule.cpp 第 30 行定义.
引用了 eve::procgen_editing::applyHeightmapBrush(), radius , 以及 strength.
◆ bind()
| void eve::heightmap_target::HeightmapTargetModule::bind | ( | editor::EditorSession * | session, |
| procgen_editing::HeightmapTarget * | target | ||
| ) | const |
Bind borrowed target and session objects without taking ownership. @thread Owner-thread only.
在文件 HeightmapTargetModule.cpp 第 26 行定义.
◆ decodeDocument()
| Result< void > eve::heightmap_target::HeightmapTargetModule::decodeDocument | ( | std::string_view | json, |
| procgen::Heightmap * | heightmap | ||
| ) | const |
Atomically replace a heightmap from a validated terrain editor JSON document.
在文件 HeightmapTargetModule.cpp 第 68 行定义.
引用了 eve::heightmap_target::decodeTerrainDocument(), eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument , 以及 eve::Result< T >::success().
◆ encodeDocument()
| Result< std::string > eve::heightmap_target::HeightmapTargetModule::encodeDocument | ( | const procgen::Heightmap * | heightmap, |
| float | spacingX, | ||
| float | spacingZ | ||
| ) | const |
Encode an editable heightmap as the versioned terrain editor JSON document.
在文件 HeightmapTargetModule.cpp 第 57 行定义.
引用了 eve::heightmap_target::encodeTerrainDocument(), eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument, spacingX, spacingZ , 以及 eve::Result< T >::success().
◆ Module_REG()
| eve::heightmap_target::HeightmapTargetModule::Module_REG | ( | HeightmapTargetModule | ) |
◆ newMesh()
| graphics::Mesh * eve::heightmap_target::HeightmapTargetModule::newMesh | ( | procgen::Heightmap * | heightmap, |
| float | cellSize, | ||
| float | heightScale | ||
| ) | const |
Compatibility projection that creates a flat-shaded preview mesh. @thread Render-thread only.
在文件 HeightmapTargetModule.cpp 第 36 行定义.
◆ newSmoothMesh()
| graphics::Mesh * eve::heightmap_target::HeightmapTargetModule::newSmoothMesh | ( | procgen::Heightmap * | heightmap, |
| float | cellSize, | ||
| float | heightScale | ||
| ) | const |
Compatibility projection that creates a smooth-normal preview mesh. @thread Render-thread only.
在文件 HeightmapTargetModule.cpp 第 46 行定义.
◆ newTarget()
| std::unique_ptr< procgen_editing::HeightmapTarget > eve::heightmap_target::HeightmapTargetModule::newTarget | ( | std::string | id, |
| procgen::Heightmap * | heightmap | ||
| ) | const |
Create an independently owned adapter over a borrowed heightmap.
在文件 HeightmapTargetModule.cpp 第 21 行定义.
◆ updateMesh()
| bool eve::heightmap_target::HeightmapTargetModule::updateMesh | ( | graphics::Mesh * | mesh, |
| graphics::Graphics * | graphics, | ||
| procgen::Heightmap * | heightmap, | ||
| float | cellSize, | ||
| float | heightScale | ||
| ) | const |
Compatibility projection that updates a flat-shaded preview mesh. @thread Render-thread only.
在文件 HeightmapTargetModule.cpp 第 41 行定义.
引用了 mesh , 以及 eve::procgen_graphics_editing::updateHeightmapMesh().
◆ updateSmoothMesh()
| bool eve::heightmap_target::HeightmapTargetModule::updateSmoothMesh | ( | graphics::Mesh * | mesh, |
| graphics::Graphics * | graphics, | ||
| procgen::Heightmap * | heightmap, | ||
| float | cellSize, | ||
| float | heightScale | ||
| ) | const |
Compatibility projection that updates a smooth-normal preview mesh. @thread Render-thread only.
在文件 HeightmapTargetModule.cpp 第 52 行定义.
引用了 mesh , 以及 eve::procgen_graphics_editing::updateHeightmapMesh().
该类的文档由以下文件生成:
- src/modules/procgen/heightmap_target/HeightmapTargetModule.h
- src/modules/procgen/heightmap_target/HeightmapTargetModule.cpp
Public 成员函数 继承自