MeshifAI API Reference
Core API
Meshifai.GenerateModel
Meshifai.GenerateModel
The primary method for generating 3D models from text descriptions.
public static object GenerateModel(
string prompt,
Action<GameObject> onComplete,
Action<string> onError = null,
Action<string, float> onStatus = null,
float variance = 0.2f,
bool applyDefaultMaterial = true
)
Parameters
prompt
string
Text description of the model to generate
onComplete
Action<GameObject>
Callback when generation completes successfully
onError
Action<string>
(Optional) Callback when an error occurs
onStatus
Action<string, float>
(Optional) Callback for status updates (message and progress 0-1)
variance
float
(Optional) Controls randomness/diversity of generation (0-1)
applyDefaultMaterial
bool
(Optional) Whether to apply a default material
Returns
object
: A handle that can be used to cancel the generation
Example
var handle = Meshifai.GenerateModel(
"A cyberpunk city building",
model => {
// Handle the completed model
},
error => {
// Handle any errors
},
(status, progress) => {
// Show generation progress
},
variance: 0.3f
);
Meshifai.CancelGeneration
Meshifai.CancelGeneration
Cancels an in-progress model generation.
public static void CancelGeneration(object handle)
Parameters
handle
object
The handle returned by GenerateModel
Example
// Start generation and store the handle
var handle = Meshifai.GenerateModel("A dragon", OnModelGenerated);
// Later, cancel the generation if needed
Meshifai.CancelGeneration(handle);
Meshifai.CloneModel
Meshifai.CloneModel
Creates a copy of an existing MeshifAI-generated model, preserving all metadata.
public static GameObject CloneModel(GameObject originalModel)
Parameters
originalModel
GameObject
The original model to copy
Returns
GameObject
: A new copy of the model with all generation data preserved
Example
// Clone an existing MeshifAI model
GameObject original = /* a MeshifAI-generated model */;
GameObject copy = Meshifai.CloneModel(original);
ModelGenerationData Component
Each generated model has a ModelGenerationData
component attached that contains information about how it was created.
Properties
Prompt
string
The text description used to generate the model
Variance
float
The variance value used during generation
GenerationTime
DateTime
When the model was generated
Example
Example
// Accessing generation data
ModelGenerationData data = model.GetComponent<ModelGenerationData>();
Debug.Log($"Generated from prompt: {data.Prompt}");
Debug.Log($"With variance: {data.Variance}");
Debug.Log($"At time: {data.GenerationTime}");
Last updated