3d_plugin.h File Reference

describes the runtime-loadable interface to support loading and parsing of 3D models. More...

#include "plugins/kicad_plugin.h"

Go to the source code of this file.

Macros
#define	KICAD_PLUGIN_CLASS   "PLUGIN_3D"
#define	MAJOR   1
#define	MINOR   0
#define	REVISION   0
#define	PATCH   0

Functions
KICAD_PLUGIN_EXPORT char const *	GetKicadPluginClass (void)
	Function GetKicadPluginClass returns the name of the implemented plugin class; for example 3DPLUGIN.
KICAD_PLUGIN_EXPORT void	GetClassVersion (unsigned char *Major, unsigned char *Minor, unsigned char *Patch, unsigned char *Revision)
	Function GetClassVersion retrieves the version of the Plugin Class.
KICAD_PLUGIN_EXPORT bool	CheckClassVersion (unsigned char Major, unsigned char Minor, unsigned char Patch, unsigned char Revision)
	Function CheckClassVersion returns true if the class version reported by the Plugin Loader is compatible with the specific implementation of a plugin.
KICAD_PLUGIN_EXPORT int	GetNExtensions (void)
	Function GetNExtensions.
KICAD_PLUGIN_EXPORT char const *	GetModelExtension (int aIndex)
	Function GetModelExtension.
KICAD_PLUGIN_EXPORT int	GetNFilters (void)
	Function GetNFilters.
KICAD_PLUGIN_EXPORT char const *	GetFileFilter (int aIndex)
	Function GetFileFilter.
KICAD_PLUGIN_EXPORT bool	CanRender (void)
	Function CanRender.
KICAD_PLUGIN_EXPORT SCENEGRAPH *	Load (char const *aFileName)
	reads a model file and creates a generic display structure

Detailed Description

describes the runtime-loadable interface to support loading and parsing of 3D models.

Definition in file 3d_plugin.h.

Macro Definition Documentation

KICAD_PLUGIN_CLASS

#define KICAD_PLUGIN_CLASS   "PLUGIN_3D"

Definition at line 40 of file 3d_plugin.h.

MAJOR

#define MAJOR   1

Definition at line 41 of file 3d_plugin.h.

MINOR

#define MINOR   0

Definition at line 42 of file 3d_plugin.h.

PATCH

#define PATCH   0

Definition at line 44 of file 3d_plugin.h.

REVISION

#define REVISION   0

Definition at line 43 of file 3d_plugin.h.

Function Documentation

CanRender()

KICAD_PLUGIN_EXPORT bool CanRender

(

void

)

Function CanRender.

Returns

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

Definition at line 295 of file s3d_plugin_idf.cpp.

CheckClassVersion()

KICAD_PLUGIN_EXPORT bool CheckClassVersion	(	unsigned char	Major,
		unsigned char	Minor,
		unsigned char	Patch,
		unsigned char	Revision
	)

Function CheckClassVersion returns true if the class version reported by the Plugin Loader is compatible with the specific implementation of a plugin.

This function must be defined by each specific plugin and it is the plugin developer's responsibility to ensure that the Plugin is in fact compatible with the Plugin Loader. The Plugin Loader shall reject any Plugin with a different Major number regardless of the return value of this function.

Definition at line 73 of file 3d_plugin.h.

References MAJOR.

GetClassVersion()

KICAD_PLUGIN_EXPORT void GetClassVersion	(	unsigned char *	Major,
		unsigned char *	Minor,
		unsigned char *	Patch,
		unsigned char *	Revision
	)

Function GetClassVersion retrieves the version of the Plugin Class.

This value is used to ensure API compatibility of a plugin as per typical practice. This must be implemented in a source module which is compiled as part of every implementation of a specific plugin class

Parameters

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

Definition at line 55 of file 3d_plugin.h.

References MAJOR, MINOR, PATCH, and REVISION.

GetFileFilter()

KICAD_PLUGIN_EXPORT char const * GetFileFilter

(

int

aIndex

)

Function GetFileFilter.

Returns

the file filter string for the given index

Definition at line 286 of file s3d_plugin_idf.cpp.

References file_data, FILE_DATA::filters, and NFILS.

GetKicadPluginClass()

KICAD_PLUGIN_EXPORT char const * GetKicadPluginClass

(

void

)

Function GetKicadPluginClass returns the name of the implemented plugin class; for example 3DPLUGIN.

This should be implemented in a source module which is compiled as part of every implementation of a specific plugin class.

Returns

is the NULL-terminated UTF-8 string representing the plugin class

Definition at line 49 of file 3d_plugin.h.

References KICAD_PLUGIN_CLASS.

GetModelExtension()

KICAD_PLUGIN_EXPORT char const * GetModelExtension

(

int

aIndex

)

Function GetModelExtension.

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 271 of file s3d_plugin_idf.cpp.

References FILE_DATA::extensions, file_data, and NEXTS.

GetNExtensions()

KICAD_PLUGIN_EXPORT int GetNExtensions

(

void

)

Function GetNExtensions.

Returns

the number of extensions supported by the plugin

Definition at line 265 of file s3d_plugin_idf.cpp.

References FILE_DATA::extensions, file_data, and NEXTS.

GetNFilters()

KICAD_PLUGIN_EXPORT int GetNFilters

(

void

)

Function GetNFilters.

Returns

the number of file filters

Definition at line 280 of file s3d_plugin_idf.cpp.

References file_data, FILE_DATA::filters, and NFILS.

Load()

KICAD_PLUGIN_EXPORT SCENEGRAPH * Load

(

char const *

aFileName

)

reads 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 302 of file s3d_plugin_idf.cpp.

References loadIDFBoard(), loadIDFOutline(), LoadModel(), LoadVRML(), LoadX3D(), and S3D::WriteVRML().

Referenced by CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::PIN::Parse().