/*
 * Copyright (C) 2023  Christopher J. Howard
 *
 * This file is part of Antkeeper source code.
 *
 * Antkeeper source code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Antkeeper source code is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Antkeeper source code.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ANTKEEPER_GAME_ANT_ANTENNAE_GENE_HPP
#define ANTKEEPER_GAME_ANT_ANTENNAE_GENE_HPP

#include "game/ant/genes/ant-gene.hpp"
#include <engine/render/model.hpp>
#include <memory>
#include <cstdint>

/**
 * Ant antennae phene.
 *
 * @see https://www.antwiki.org/wiki/Character_States_for_Extant_Ant_Genera_of_the_Formicidae
 * @see https://www.antwiki.org/wiki/Morphological_Measurements
 */
struct ant_antennae_phene
{
	/// Total number of antennal segments per antenna.
	std::uint8_t total_antennomere_count{0};
	
	/// Number of antennal segments that constitute a club.
	std::uint8_t club_antennomere_count{0};
	
	/**
	 * 3D model of the antennae.
	 *
	 * The antennae model skeleton must contain the following bones:
	 *
	 * * antennomere1_l
	 * * * antennomere2_l
	 * * * * ...
	 * * * * * antennomere`<n>`_l
	 * * antennomere1_r
	 * * * antennomere2_r
	 * * * * ...
	 * * * * * antennomere`<n>`_r
	 *
	 * Where `<n>` is the total number of antennal segments per antenna. 
	 */
	std::shared_ptr<render::model> model;
};

/// Ant antennae gene.
using ant_antennae_gene = ant_gene<ant_antennae_phene>;

template <>
inline constexpr ant_gene_type ant_antennae_gene::type() const noexcept
{
	return ant_gene_type::antennae;
}

#endif // ANTKEEPER_GAME_ANT_ANTENNAE_GENE_HPP