#include <pluginldr3D.h>

Inheritance diagram for KICAD_PLUGIN_LDR_3D:

Public Member Functions
	KICAD_PLUGIN_LDR_3D ()

virtual	~KICAD_PLUGIN_LDR_3D ()

bool	Open (const wxString &aFullFileName) override
	Open a plugin of the given class, performs version compatibility checks, and links all required functions.

void	Close (void) override
	Clean up and closes/unloads the plugin.

void	GetLoaderVersion (unsigned char Major, unsigned char Minor, unsigned char Revision, unsigned char Patch) const override
	Return the version information of the Plugin Loader for plugin compatibility checking.

int	GetNExtensions (void)

char const *	GetModelExtension (int aIndex)

int	GetNFilters (void)

char const *	GetFileFilter (int aIndex)

bool	CanRender (void)

SCENEGRAPH *	Load (char const *aFileName)

std::string	GetLastError (void) const
	Return the value of the internal error string.

char const *	GetKicadPluginClass (void)

bool	GetClassVersion (unsigned char Major, unsigned char Minor, unsigned char Patch, unsigned char Revision)

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

const char *	GetKicadPluginName (void)

bool	GetVersion (unsigned char Major, unsigned char Minor, unsigned char Patch, unsigned char Revision)

void	GetPluginInfo (std::string &aPluginInfo)

Protected Member Functions
bool	open (const wxString &aFullFileName, const char *aPluginClass)
	Open a plugin of the specified class and links the extensions required by kicad_plugin.

void	close (void)
	Nullify internal pointers in preparation for closing the plugin.

bool	reopen (void)
	Reopen a plugin.

Protected Attributes
std::string	m_error

wxDynamicLibrary	m_PluginLoader

Detailed Description

Definition at line 52 of file pluginldr3D.h.

Constructor & Destructor Documentation

◆ KICAD_PLUGIN_LDR_3D()

KICAD_PLUGIN_LDR_3D::KICAD_PLUGIN_LDR_3D ( )

Definition at line 39 of file pluginldr3D.cpp.

References m_canRender, m_getFileFilter, m_getModelExtension, m_getNExtensions, m_getNFilters, m_load, and ok.

◆ ~KICAD_PLUGIN_LDR_3D()

KICAD_PLUGIN_LDR_3D::~KICAD_PLUGIN_LDR_3D ( )

virtual

Definition at line 53 of file pluginldr3D.cpp.

References Close().

Member Function Documentation

◆ CanRender()

bool KICAD_PLUGIN_LDR_3D::CanRender ( void )

Definition at line 361 of file pluginldr3D.cpp.

References m_canRender, KICAD_PLUGIN_LDR::m_error, ok, KICAD_PLUGIN_LDR::reopen(), and tracePluginLoader.

◆ CheckClassVersion()

bool KICAD_PLUGIN_LDR::CheckClassVersion	(	unsigned char	Major,
		unsigned char	Minor,
		unsigned char	Patch,
		unsigned char	Revision )

inherited

Definition at line 380 of file pluginldr.cpp.

References m_checkClassVersion, m_error, ok, reopen(), and tracePluginLoader.

◆ Close()

void KICAD_PLUGIN_LDR_3D::Close ( void )

overridevirtual

Clean up and closes/unloads the plugin.

Implements KICAD_PLUGIN_LDR.

Definition at line 210 of file pluginldr3D.cpp.

References KICAD_PLUGIN_LDR::close(), m_canRender, m_getFileFilter, m_getModelExtension, m_getNExtensions, m_getNFilters, m_load, ok, and tracePluginLoader.

Referenced by S3D_PLUGIN_MANAGER::loadPlugins(), Open(), and ~KICAD_PLUGIN_LDR_3D().

◆ close()

void KICAD_PLUGIN_LDR::close ( void )

protectedinherited

Nullify internal pointers in preparation for closing the plugin.

Definition at line 261 of file pluginldr.cpp.

References m_checkClassVersion, m_getClassVersion, m_getPluginClass, m_getPluginName, m_getVersion, m_PluginLoader, and ok.

Referenced by KICAD_PLUGIN_LDR_3D::Close(), open(), and ~KICAD_PLUGIN_LDR().

◆ GetClassVersion()

bool KICAD_PLUGIN_LDR::GetClassVersion	(	unsigned char *	Major,
		unsigned char *	Minor,
		unsigned char *	Patch,
		unsigned char *	Revision )

inherited

Definition at line 321 of file pluginldr.cpp.

References m_checkClassVersion, m_error, m_getClassVersion, ok, reopen(), and tracePluginLoader.

◆ GetFileFilter()

char const * KICAD_PLUGIN_LDR_3D::GetFileFilter ( int aIndex )

Definition at line 334 of file pluginldr3D.cpp.

References KICAD_PLUGIN_LDR::m_error, m_getFileFilter, ok, KICAD_PLUGIN_LDR::reopen(), and tracePluginLoader.

Referenced by S3D_PLUGIN_MANAGER::loadPlugins().

◆ GetKicadPluginClass()

char const * KICAD_PLUGIN_LDR::GetKicadPluginClass ( void )

inherited

Definition at line 294 of file pluginldr.cpp.

References m_error, m_getPluginClass, ok, reopen(), and tracePluginLoader.

◆ GetKicadPluginName()

const char * KICAD_PLUGIN_LDR::GetKicadPluginName ( void )

inherited

Definition at line 408 of file pluginldr.cpp.

References m_error, m_getPluginName, ok, reopen(), and tracePluginLoader.

Referenced by open().

◆ GetLastError()

std::string KICAD_PLUGIN_LDR::GetLastError ( void ) const

inherited

Return the value of the internal error string.

Definition at line 288 of file pluginldr.cpp.

References m_error.

◆ GetLoaderVersion()

void KICAD_PLUGIN_LDR_3D::GetLoaderVersion	(	unsigned char *	Major,
		unsigned char *	Minor,
		unsigned char *	Patch,
		unsigned char *	Revision ) const

overridevirtual

Return the version information of the Plugin Loader for plugin compatibility checking.

Implements KICAD_PLUGIN_LDR.

Definition at line 234 of file pluginldr3D.cpp.

References PLUGIN_3D_MAJOR, PLUGIN_3D_MINOR, PLUGIN_3D_PATCH, and PLUGIN_3D_REVISION.

◆ GetModelExtension()

char const * KICAD_PLUGIN_LDR_3D::GetModelExtension ( int aIndex )

Definition at line 280 of file pluginldr3D.cpp.

References KICAD_PLUGIN_LDR::m_error, m_getModelExtension, ok, KICAD_PLUGIN_LDR::reopen(), and tracePluginLoader.

Referenced by S3D_PLUGIN_MANAGER::addExtensionMap().

◆ GetNExtensions()

int KICAD_PLUGIN_LDR_3D::GetNExtensions ( void )

Definition at line 253 of file pluginldr3D.cpp.

References KICAD_PLUGIN_LDR::m_error, m_getNExtensions, ok, KICAD_PLUGIN_LDR::reopen(), and tracePluginLoader.

Referenced by S3D_PLUGIN_MANAGER::addExtensionMap().

◆ GetNFilters()

int KICAD_PLUGIN_LDR_3D::GetNFilters ( void )

Definition at line 307 of file pluginldr3D.cpp.

References KICAD_PLUGIN_LDR::m_error, m_getNFilters, ok, KICAD_PLUGIN_LDR::reopen(), and tracePluginLoader.

Referenced by S3D_PLUGIN_MANAGER::loadPlugins().

◆ GetPluginInfo()

void KICAD_PLUGIN_LDR::GetPluginInfo ( std::string & aPluginInfo )

inherited

Definition at line 465 of file pluginldr.cpp.

References m_pluginInfo.

◆ GetVersion()

bool KICAD_PLUGIN_LDR::GetVersion	(	unsigned char *	Major,
		unsigned char *	Minor,
		unsigned char *	Patch,
		unsigned char *	Revision )

inherited

Definition at line 435 of file pluginldr.cpp.

References m_error, m_getVersion, ok, reopen(), and tracePluginLoader.

Referenced by open().

◆ Load()

SCENEGRAPH * KICAD_PLUGIN_LDR_3D::Load ( char const * aFileName )

Definition at line 388 of file pluginldr3D.cpp.

References KICAD_PLUGIN_LDR::m_error, m_load, ok, KICAD_PLUGIN_LDR::reopen(), and tracePluginLoader.

◆ Open()

bool KICAD_PLUGIN_LDR_3D::Open ( const wxString & aFullFileName )

overridevirtual

Open a plugin of the given class, performs version compatibility checks, and links all required functions.

Returns: true on success or false if failure. An error message may be accessible via GetLastError()

Implements KICAD_PLUGIN_LDR.

Definition at line 61 of file pluginldr3D.cpp.

References Close(), LINK_ITEM, m_canRender, KICAD_PLUGIN_LDR::m_error, m_getFileFilter, m_getModelExtension, m_getNExtensions, m_getNFilters, m_load, ok, KICAD_PLUGIN_LDR::open(), PLUGIN_CLASS_3D, and tracePluginLoader.

Referenced by S3D_PLUGIN_MANAGER::loadPlugins().

◆ open()

bool KICAD_PLUGIN_LDR::open	(	const wxString &	aFullFileName,
		const char *	aPluginClass )

protectedinherited

Open a plugin of the specified class and links the extensions required by kicad_plugin.

Returns: true on success otherwise false.

Definition at line 63 of file pluginldr.cpp.

References Close(), close(), GetKicadPluginName(), GetLoaderVersion(), GetVersion(), LINK_ITEM, m_checkClassVersion, m_error, m_fileName, m_getClassVersion, m_getPluginClass, m_getPluginName, m_getVersion, m_pluginInfo, m_PluginLoader, ok, and tracePluginLoader.

Referenced by KICAD_PLUGIN_LDR_3D::Open().

◆ reopen()

bool KICAD_PLUGIN_LDR::reopen ( void )

protectedinherited

Reopen a plugin.

Returns: true on success or false on failure.

Definition at line 275 of file pluginldr.cpp.

References m_error, m_fileName, and Open().

Referenced by KICAD_PLUGIN_LDR_3D::CanRender(), CheckClassVersion(), GetClassVersion(), KICAD_PLUGIN_LDR_3D::GetFileFilter(), GetKicadPluginClass(), GetKicadPluginName(), KICAD_PLUGIN_LDR_3D::GetModelExtension(), KICAD_PLUGIN_LDR_3D::GetNExtensions(), KICAD_PLUGIN_LDR_3D::GetNFilters(), GetVersion(), and KICAD_PLUGIN_LDR_3D::Load().

Member Data Documentation

◆ m_canRender

PLUGIN_3D_CAN_RENDER KICAD_PLUGIN_LDR_3D::m_canRender

private

Definition at line 83 of file pluginldr3D.h.

Referenced by CanRender(), Close(), KICAD_PLUGIN_LDR_3D(), and Open().

◆ m_checkClassVersion

CHECK_CLASS_VERSION KICAD_PLUGIN_LDR::m_checkClassVersion

privateinherited

Definition at line 143 of file pluginldr.h.

Referenced by CheckClassVersion(), close(), GetClassVersion(), KICAD_PLUGIN_LDR(), and open().

◆ m_error

std::string KICAD_PLUGIN_LDR::m_error

protectedinherited

Definition at line 134 of file pluginldr.h.

Referenced by KICAD_PLUGIN_LDR_3D::CanRender(), CheckClassVersion(), GetClassVersion(), KICAD_PLUGIN_LDR_3D::GetFileFilter(), GetKicadPluginClass(), GetKicadPluginName(), GetLastError(), KICAD_PLUGIN_LDR_3D::GetModelExtension(), KICAD_PLUGIN_LDR_3D::GetNExtensions(), KICAD_PLUGIN_LDR_3D::GetNFilters(), GetVersion(), KICAD_PLUGIN_LDR_3D::Load(), KICAD_PLUGIN_LDR_3D::Open(), open(), and reopen().

◆ m_fileName

wxString KICAD_PLUGIN_LDR::m_fileName

privateinherited

Definition at line 146 of file pluginldr.h.

Referenced by open(), and reopen().

◆ m_getClassVersion

GET_CLASS_VERSION KICAD_PLUGIN_LDR::m_getClassVersion

privateinherited

Definition at line 142 of file pluginldr.h.

Referenced by close(), GetClassVersion(), KICAD_PLUGIN_LDR(), and open().

◆ m_getFileFilter

PLUGIN_3D_GET_FILE_FILTER KICAD_PLUGIN_LDR_3D::m_getFileFilter

private

Definition at line 82 of file pluginldr3D.h.

Referenced by Close(), GetFileFilter(), KICAD_PLUGIN_LDR_3D(), and Open().

◆ m_getModelExtension

PLUGIN_3D_GET_MODEL_EXTENSION KICAD_PLUGIN_LDR_3D::m_getModelExtension

private

Definition at line 80 of file pluginldr3D.h.

Referenced by Close(), GetModelExtension(), KICAD_PLUGIN_LDR_3D(), and Open().

◆ m_getNExtensions

PLUGIN_3D_GET_N_EXTENSIONS KICAD_PLUGIN_LDR_3D::m_getNExtensions

private

Definition at line 79 of file pluginldr3D.h.

Referenced by Close(), GetNExtensions(), KICAD_PLUGIN_LDR_3D(), and Open().

◆ m_getNFilters

PLUGIN_3D_GET_N_FILTERS KICAD_PLUGIN_LDR_3D::m_getNFilters

private

Definition at line 81 of file pluginldr3D.h.

Referenced by Close(), GetNFilters(), KICAD_PLUGIN_LDR_3D(), and Open().

◆ m_getPluginClass

GET_PLUGIN_CLASS KICAD_PLUGIN_LDR::m_getPluginClass

privateinherited

Definition at line 141 of file pluginldr.h.

Referenced by close(), GetKicadPluginClass(), KICAD_PLUGIN_LDR(), and open().

◆ m_getPluginName

GET_PLUGIN_NAME KICAD_PLUGIN_LDR::m_getPluginName

privateinherited

Definition at line 144 of file pluginldr.h.

Referenced by close(), GetKicadPluginName(), KICAD_PLUGIN_LDR(), and open().

◆ m_getVersion

GET_VERSION KICAD_PLUGIN_LDR::m_getVersion

privateinherited

Definition at line 145 of file pluginldr.h.

Referenced by close(), GetVersion(), KICAD_PLUGIN_LDR(), and open().

◆ m_load

PLUGIN_3D_LOAD KICAD_PLUGIN_LDR_3D::m_load

private

Definition at line 84 of file pluginldr3D.h.

Referenced by Close(), KICAD_PLUGIN_LDR_3D(), Load(), and Open().

◆ m_pluginInfo

std::string KICAD_PLUGIN_LDR::m_pluginInfo

privateinherited

Definition at line 147 of file pluginldr.h.

Referenced by GetPluginInfo(), and open().

◆ m_PluginLoader

wxDynamicLibrary KICAD_PLUGIN_LDR::m_PluginLoader

protectedinherited

Definition at line 137 of file pluginldr.h.

Referenced by close(), and open().

◆ ok

bool KICAD_PLUGIN_LDR_3D::ok

private

Definition at line 78 of file pluginldr3D.h.

Referenced by CanRender(), Close(), GetFileFilter(), GetModelExtension(), GetNExtensions(), GetNFilters(), KICAD_PLUGIN_LDR_3D(), Load(), and Open().

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

Private Attributes
bool	ok

PLUGIN_3D_GET_N_EXTENSIONS	m_getNExtensions

PLUGIN_3D_GET_MODEL_EXTENSION	m_getModelExtension

PLUGIN_3D_GET_N_FILTERS	m_getNFilters

PLUGIN_3D_GET_FILE_FILTER	m_getFileFilter

PLUGIN_3D_CAN_RENDER	m_canRender

PLUGIN_3D_LOAD	m_load

GET_PLUGIN_CLASS	m_getPluginClass

GET_CLASS_VERSION	m_getClassVersion

CHECK_CLASS_VERSION	m_checkClassVersion

GET_PLUGIN_NAME	m_getPluginName

GET_VERSION	m_getVersion

wxString	m_fileName

std::string	m_pluginInfo

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KICAD_PLUGIN_LDR_3D()

◆ ~KICAD_PLUGIN_LDR_3D()

Member Function Documentation

◆ CanRender()

◆ CheckClassVersion()

◆ Close()

◆ close()

◆ GetClassVersion()

◆ GetFileFilter()

◆ GetKicadPluginClass()

◆ GetKicadPluginName()

◆ GetLastError()

◆ GetLoaderVersion()

◆ GetModelExtension()

◆ GetNExtensions()

◆ GetNFilters()

◆ GetPluginInfo()

◆ GetVersion()

◆ Load()

◆ Open()

◆ open()

◆ reopen()

Member Data Documentation

◆ m_canRender

◆ m_checkClassVersion

◆ m_error

◆ m_fileName

◆ m_getClassVersion

◆ m_getFileFilter

◆ m_getModelExtension

◆ m_getNExtensions

◆ m_getNFilters

◆ m_getPluginClass

◆ m_getPluginName

◆ m_getVersion

◆ m_load

◆ m_pluginInfo

◆ m_PluginLoader

◆ ok