plugin.cpp File Reference

#include "plugins/3d/3d_plugin.h"
#include "plugins/3dapi/ifsg_api.h"
#include "loadmodel.h"
#include <string>
#include <vector>

Go to the source code of this file.

Macros
#define	PLUGIN_VRML_MAJOR   1
#define	PLUGIN_VRML_MINOR   3
#define	PLUGIN_VRML_PATCH   2
#define	PLUGIN_VRML_REVNO   2

Functions
const char *	GetKicadPluginName ()
	Return the name of the plugin instance, for example IDFv3.
void	GetPluginVersion (unsigned char *aMajor, unsigned char *aMinor, unsigned char *aPatch, unsigned char *aRevision)
	Retrieve the version of the instantiated plugin for informational purposes.
int	GetNExtensions ()
char const *	GetModelExtension (int aIndex)
int	GetNFilters ()
char const *	GetFileFilter (int aIndex)
bool	CanRender ()
SCENEGRAPH *	Load (char const *aFileName)
	Read a model file and creates a generic display structure.

Variables
static const std::vector< std::string >	extensions = { "wrl", "WRL", "wrz", "WRZ", "x3d", "X3D" }
static const std::vector< std::string >	filters

Macro Definition Documentation

PLUGIN_VRML_MAJOR

#define PLUGIN_VRML_MAJOR   1

Definition at line 28 of file plugin.cpp.

Referenced by GetPluginVersion().

PLUGIN_VRML_MINOR

#define PLUGIN_VRML_MINOR   3

Definition at line 29 of file plugin.cpp.

Referenced by GetPluginVersion().

PLUGIN_VRML_PATCH

#define PLUGIN_VRML_PATCH   2

Definition at line 30 of file plugin.cpp.

Referenced by GetPluginVersion().

PLUGIN_VRML_REVNO

#define PLUGIN_VRML_REVNO   2

Definition at line 31 of file plugin.cpp.

Referenced by GetPluginVersion().

Function Documentation

CanRender()

bool CanRender

(

void

)

Returns

true if the plugin can render a model, that is the Load() function is implemented.

Definition at line 95 of file plugin.cpp.

GetFileFilter()

char const * GetFileFilter

(

int

aIndex

)

Returns

the file filter string for the given index.

Definition at line 89 of file plugin.cpp.

References file_data, filters, GetNFilters(), and NFILS.

GetKicadPluginName()

const char * GetKicadPluginName

(

void

)

Return the name of the plugin instance, for example IDFv3.

This string may be used to check for name conflicts or to display informational messages about loaded plugins. This method must be implemented in specific instantiations of a plugin class.

Returns

is the NULL-terminated UTF-8 string representing the plugin name.

Definition at line 34 of file plugin.cpp.

GetModelExtension()

char const * GetModelExtension

(

int

aIndex

)

Parameters

aIndex

is the extension to return; valid values are 0 to GetNExtensions() - 1.

Returns

the requested extension or a null string if aIndex was invalid.

Definition at line 77 of file plugin.cpp.

References extensions, file_data, GetNExtensions(), and NEXTS.

GetNExtensions()

int GetNExtensions

(

void

)

Returns

the number of extensions supported by the plugin.

Definition at line 71 of file plugin.cpp.

References extensions, and NEXTS.

Referenced by GetModelExtension().

GetNFilters()

int GetNFilters

(

void

)

Returns

the number of file filters.

Definition at line 83 of file plugin.cpp.

References filters, and NFILS.

Referenced by GetFileFilter().

GetPluginVersion()

void GetPluginVersion	(	unsigned char *	Major,
		unsigned char *	Minor,
		unsigned char *	Patch,
		unsigned char *	Revision )

Retrieve the version of the instantiated plugin for informational purposes.

Do not confuse this with GetClassVersion which is used to determine API compatibility.

Parameters

Major	will hold the Plugin Major version.
Minor	will hold the Plugin Minor version.
Patch	will hold the Plugin Patch level.
Revision	will hold the Plugin Revision.

Definition at line 40 of file plugin.cpp.

References PLUGIN_3D_IDF_MAJOR, PLUGIN_3D_IDF_MINOR, PLUGIN_3D_IDF_PATCH, PLUGIN_3D_IDF_REVNO, PLUGIN_VRML_MAJOR, PLUGIN_VRML_MINOR, PLUGIN_VRML_PATCH, and PLUGIN_VRML_REVNO.

Load()

SCENEGRAPH * Load

(

char const *

aFileName

)

Read a model file and creates a generic display structure.

Parameters

aFileName

is the full path of the model file.

Returns

a SCENEGRAPH pointer to the display structure if the model was successfully loaded and NULL if there is no rendering support for the model or there were problems reading the model.

Definition at line 101 of file plugin.cpp.

References loadIDFBoard(), loadIDFOutline(), LoadVRMLModel(), and S3D::WriteVRML().

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and BOOST_FIXTURE_TEST_CASE().

Variable Documentation

extensions

const std::vector<std::string> extensions = { "wrl", "WRL", "wrz", "WRZ", "x3d", "X3D" }

static

Definition at line 63 of file plugin.cpp.

Referenced by PROJECT_ARCHIVER::Archive(), LOCAL_HISTORY::ExtractAllFilesAtCommit(), PADS_COMMON::FindRelatedPadsFiles(), GetModelExtension(), GetNExtensions(), DIALOG_IMPORT_GFX_SCH::onBrowseFiles(), DIALOG_IMPORT_GRAPHICS::onBrowseFiles(), and PANEL_FP_PROPERTIES_3D_MODEL::pick3DModel().

filters

const std::vector<std::string> filters

static

Initial value:

= {
    "VRML 1.0/2.0 (*.wrl;*.WRL;*.wrz;*.WRZ)|*.wrl;*.WRL;*.wrz;*.WRZ",
    "X3D (*.x3d;*.X3D)|*.x3d;*.X3D"
}

Definition at line 64 of file plugin.cpp.

Referenced by ApplyFootprintLinks(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), LIB_SYMBOL::Deserialize(), CVPCB_MAINFRAME::DisplayStatus(), FOOTPRINT_CHOOSER_FRAME::filterFootprint(), GetFileFilter(), GetNFilters(), LISTBOX_TRICKS::listBoxCopy(), LEGACY_NETLIST_READER::loadFootprintFilters(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_IO_KICAD_SEXPR_PARSER::parseProperty(), PANEL_FP_PROPERTIES_3D_MODEL::pick3DModel(), QueryMatchingFootprints(), and PANEL_FOOTPRINT_FILTERS::updateMatchingFootprints().