MauryDev.KoGaMa.ModelAPI 1.0.1

dotnet add package MauryDev.KoGaMa.ModelAPI --version 1.0.1
                    
NuGet\Install-Package MauryDev.KoGaMa.ModelAPI -Version 1.0.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MauryDev.KoGaMa.ModelAPI" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MauryDev.KoGaMa.ModelAPI" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="MauryDev.KoGaMa.ModelAPI" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MauryDev.KoGaMa.ModelAPI --version 1.0.1
                    
#r "nuget: MauryDev.KoGaMa.ModelAPI, 1.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package MauryDev.KoGaMa.ModelAPI@1.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MauryDev.KoGaMa.ModelAPI&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=MauryDev.KoGaMa.ModelAPI&version=1.0.1
                    
Install as a Cake Tool

KoGaMa Model API

A KoGaMa Model API é uma biblioteca leve, desenvolvida em .NET Standard 2.0, projetada para a manipulação, processamento e serialização de dados de modelos 3D do KoGaMa. Ela abstrai a complexidade de representar blocos (voxels) que possuem deformações de vértices, materiais por face e coordenadas compactadas.

🚀 Funcionalidades

  • Representação de Cubos: Modelagem completa de blocos, incluindo posição global, materiais individuais para cada face e offsets de vértices (corners).
  • Gerenciamento de Modelos: O ModelInfo agora atua como um gestor, permitindo adicionar, remover, buscar cubos por posição/material e calcular a Bounding Box do modelo.
  • Conversão de Coordenadas Bidirecional: O PositionConverter traduz bytes compactados em Vector3 e vice-versa, utilizando um sistema de grade $5 \times 5 \times 5$.
  • Estrutura de Dados Otimizada: Uso de IntVector (baseado em short) para reduzir a pegada de memória em modelos com milhares de cubos.
  • Interface de Serialização: ISerializer genérica para implementação de persistência em formatos Binários, JSON ou customizados.
  • Compatibilidade Máxima: Alvo .NET Standard 2.0 (compatível com Unity, .NET Framework e .NET Core/5+).

🛠 Arquitetura Técnica

1. ModelInfo (O Gestor do Modelo)

Não é apenas um container, mas a classe central de manipulação do modelo:

  • Busca e Filtro: Métodos como FindCubeAt(position) e GetCubesByMaterial(id).
  • Bounding Box: Calcula automaticamente os limites mínimos e máximos do modelo através do método GetBoundingBox().
  • Manipulação: Suporte a AddCube, RemoveCube e Clear.

2. Cube (A Unidade Básica)

Representa um bloco individual com as seguintes propriedades:

  • Position: Localização no grid via IntVector.
  • Materials: Array de 6 bytes (um para cada face definida no enum Face).
  • Corners: Array de 8 bytes que definem a deformação dos vértices.
    • Dica: Use Cube.IdentityByteCorners para resetar um cubo ao seu estado padrão.
  • GetCornersVectors(): Converte os bytes de corners em Vector3 reais para renderização.

3. PositionConverter (O Coração Matemático)

Mapeia um único byte (0-124) para um Vector3 baseado em uma grade de 5 níveis:

  • Valores de referência: {-0.5f, -0.25f, 0f, 0.25f, 0.5f}.
  • Cálculo:
    • $X = index / 25
    • $Y = (index % 25) / 5
    • $Z = index % 5

4. IntVector

Uma estrutura struct otimizada para coordenadas inteiras, evitando o overhead de float quando não necessário e provendo acesso via indexador (vector[0] para X, etc).


💻 Exemplos de Uso

Criando e Gerenciando um Modelo

using MauryDev.KoGaMa.ModelAPI.Model;
using MauryDev.KoGaMa.ModelAPI.Models;

var model = new ModelInfo();

// Criando um cubo na posição (0, 1, 0)
var cube = new Cube(new IntVector(0, 1, 0)) 
{
    Materials = new byte[] { 1, 1, 1, 1, 1, 1 } 
};

model.AddCube(cube);

// Verificando se existe um cubo em certa posição
if (model.HasCubeAt(new IntVector(0, 1, 0))) 
{
    var foundCube = model.FindCubeAt(new IntVector(0, 1, 0));
}

// Obtendo a Bounding Box do modelo
var (min, max) = model.GetBoundingBox();
Console.WriteLine($"Modelo expande de {min} até {max}");

Trabalhando com Vértices (Corners)

var cube = new Cube(new IntVector(0, 0, 0));
cube.Corners = Cube.IdentityByteCorners; // Define corners padrão

// Obtém as posições reais dos 8 vértices para renderização
System.Numerics.Vector3[] vertices = cube.GetCornersVectors();

foreach (var v in vertices)
{
    Console.WriteLine($"Vértice: {v}");
}

Conversão Manual de Coordenadas

using MauryDev.KoGaMa.ModelAPI.Utils;

// De Byte para Vector3
byte byteVal = 124; 
System.Numerics.Vector3 vec = PositionConverter.GetVectorFromByte(byteVal);

// De Vector3 para Byte
byte backToByte = PositionConverter.GetByteFromVector(vec);

📦 Instalação

Adicione a referência à DLL compilada ao seu projeto ou inclua os arquivos fonte.

Dependências:

  • System.Numerics.Vectors (v4.6.1+)

📐 Tabela de Coordenadas (Grid 5x5x5)

Índice Valor Float
0 -0.5f
1 -0.25f
2 0f
3 0.25f
4 0.5f

👤 Autor

  • MauryDev

📄 Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on MauryDev.KoGaMa.ModelAPI:

Package Downloads
MauryDev.KoGaMa.AvatarAPI

avatar api kogama core

MauryDev.KoGaMa.ModelAPI.KoGaMaTools

ModelAPI KoGaMa Tools

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 0 6/19/2026
1.0.0 46 6/17/2026