KiCad PCB EDA Suite
Loading...
Searching...
No Matches
KICAD_PLUGIN_LDR_3D Class Reference

#include <pluginldr3D.h>

Inheritance diagram for KICAD_PLUGIN_LDR_3D:
KICAD_PLUGIN_LDR

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. More...
 
void Close (void) override
 Clean up and closes/unloads the plugin. More...
 
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. More...
 
int GetNExtensions (void)
 
char const * GetModelExtension (int aIndex)
 
int GetNFilters (void)
 
char const * GetFileFilter (int aIndex)
 
bool CanRender (void)
 
SCENEGRAPHLoad (char const *aFileName)
 
std::string GetLastError (void) const
 Return the value of the internal error string. More...
 
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. More...
 
void close (void)
 Nullify internal pointers in preparation for closing the plugin. More...
 
bool reopen (void)
 Reopen a plugin. More...
 

Protected Attributes

std::string m_error
 
wxDynamicLibrary m_PluginLoader
 

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
 

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 ( )

◆ ~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  )

◆ CheckClassVersion()

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

◆ close()

void KICAD_PLUGIN_LDR::close ( void  )
protectedinherited

◆ Close()

void KICAD_PLUGIN_LDR_3D::Close ( void  )
overridevirtual

◆ GetClassVersion()

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

◆ GetFileFilter()

char const * KICAD_PLUGIN_LDR_3D::GetFileFilter ( int  aIndex)

◆ GetKicadPluginClass()

char const * KICAD_PLUGIN_LDR::GetKicadPluginClass ( void  )
inherited

◆ GetKicadPluginName()

const char * KICAD_PLUGIN_LDR::GetKicadPluginName ( void  )
inherited

◆ 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 KICAD_PLUGIN_LDR::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)

◆ GetNExtensions()

int KICAD_PLUGIN_LDR_3D::GetNExtensions ( void  )

◆ GetNFilters()

int KICAD_PLUGIN_LDR_3D::GetNFilters ( void  )

◆ GetPluginInfo()

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

Definition at line 465 of file pluginldr.cpp.

References KICAD_PLUGIN_LDR::m_pluginInfo.

◆ GetVersion()

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

◆ Load()

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

◆ 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

◆ reopen()

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

◆ m_error

◆ m_fileName

wxString KICAD_PLUGIN_LDR::m_fileName
privateinherited

Definition at line 146 of file pluginldr.h.

Referenced by KICAD_PLUGIN_LDR::open(), and KICAD_PLUGIN_LDR::reopen().

◆ m_getClassVersion

GET_CLASS_VERSION KICAD_PLUGIN_LDR::m_getClassVersion
privateinherited

◆ 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

◆ m_getPluginName

GET_PLUGIN_NAME KICAD_PLUGIN_LDR::m_getPluginName
privateinherited

◆ m_getVersion

GET_VERSION KICAD_PLUGIN_LDR::m_getVersion
privateinherited

◆ 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 KICAD_PLUGIN_LDR::GetPluginInfo(), and KICAD_PLUGIN_LDR::open().

◆ m_PluginLoader

wxDynamicLibrary KICAD_PLUGIN_LDR::m_PluginLoader
protectedinherited

Definition at line 137 of file pluginldr.h.

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

◆ ok

bool KICAD_PLUGIN_LDR_3D::ok
private

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