VIPRA Documentation
Loading...
Searching...
No Matches
DXF Class Reference

Parameter and Polygon qualified dxf input module. More...

#include <dxf.hpp>

Inheritance diagram for DXF:
Collaboration diagram for DXF:

Public Member Functions

 VIPRA_MODULE_NAME ("DXF")
 
 VIPRA_MODULE_TYPE (MapInput)
 
void load (std::string const &filepath) override
 Loads the DXF file from the given path.
 
auto serialize () -> std::string override
 
void parse (std::string const &) override
 
auto get_obstacles () const -> std::optional< std::vector< VIPRA::Geometry::Polygon > > override
 Returns obstacles geometry from the .dxf file.
 
auto get_spawns () const -> std::optional< std::vector< VIPRA::Geometry::Polygon > > override
 Returns spawn area geometry from the .dxf file.
 
auto get_objectives () const -> std::optional< std::map< std::string, std::vector< VIPRA::Geometry::Polygon > > > override
 Returns Objectives map from the .dxf file.
 
auto get_areas () const -> std::optional< std::map< std::string, VIPRA::Geometry::Polygon > > override
 Returns spawn area geometry from the .dxf file.
 
auto get_objective_types (std::vector< std::string > const &keys) const -> std::optional< std::vector< std::string > >
 
- Public Member Functions inherited from VIPRA::Modules::Module< DXF >
void register_params (Parameters &paramIn)
 Registers the modules parameters with the parameter reader.
 
void config (Parameters &paramIn, VIPRA::Random::Engine &engine)
 Loads in all parameters for the module.
 
- Public Member Functions inherited from VIPRA::Modules::Serializable
 Serializable (const Serializable &)=default
 
 Serializable (Serializable &&)=default
 
auto operator= (const Serializable &) -> Serializable &=default
 
auto operator= (Serializable &&) -> Serializable &=default
 
- Public Member Functions inherited from VIPRA::Modules::MapInput
 MapInput (const MapInput &)=default
 
 MapInput (MapInput &&)=default
 
auto operator= (const MapInput &) -> MapInput &=default
 
auto operator= (MapInput &&) -> MapInput &=default
 

Static Public Member Functions

static auto get_polygons (std::vector< std::shared_ptr< DRW_Vertex > > &vertexList) -> std::optional< std::vector< VIPRA::Geometry::Polygon > >
 

Detailed Description

Parameter and Polygon qualified dxf input module.

Member Function Documentation

◆ get_areas()

auto DXF::get_areas ( ) const -> std::optional<std::map<std::string, VIPRA::Geometry::Polygon>>
nodiscardoverridevirtual

Returns spawn area geometry from the .dxf file.

Returns
std::optional<std::string, std::vector<VIPRA::Geometry::Polygon>>

Implements VIPRA::Modules::MapInput.

◆ get_objectives()

auto DXF::get_objectives ( ) const -> std::optional< std::map<std::string, std::vector<VIPRA::Geometry::Polygon>>>
nodiscardoverridevirtual

Returns Objectives map from the .dxf file.

Returns
std::optional<std::vector<VIPRA::Geometry::Polygon>>

Implements VIPRA::Modules::MapInput.

◆ get_obstacles()

auto DXF::get_obstacles ( ) const -> std::optional<std::vector<VIPRA::Geometry::Polygon>>
nodiscardoverridevirtual

Returns obstacles geometry from the .dxf file.

Returns
std::optional<std::vector<VIPRA::Geometry::Polygon>>

Implements VIPRA::Modules::MapInput.

◆ get_spawns()

auto DXF::get_spawns ( ) const -> std::optional<std::vector<VIPRA::Geometry::Polygon>>
nodiscardoverridevirtual

Returns spawn area geometry from the .dxf file.

Returns
std::optional<std::vector<VIPRA::Geometry::Polygon>>

Implements VIPRA::Modules::MapInput.

◆ load()

void DXF::load ( std::string const & filepath)
overridevirtual

Loads the DXF file from the given path.

Parameters
filepath

https://github.com/codelibs/libdxfrw

Implements VIPRA::Modules::MapInput.

◆ parse()

void DXF::parse ( std::string const & )
inlineoverridevirtual

◆ serialize()

auto DXF::serialize ( ) -> std::string
inlinenodiscardoverridevirtual

The documentation for this class was generated from the following files: