oce.cpp File Reference

#include <wx/filename.h>
#include "plugins/3d/3d_plugin.h"
#include "plugins/3dapi/ifsg_all.h"
#include "loadmodel.h"
#include <advanced_config.h>
#include <string>
#include <vector>

Go to the source code of this file.

Classes
struct	FILE_DATA

Macros
#define	PLUGIN_OCE_MAJOR   1
#define	PLUGIN_OCE_MINOR   4
#define	PLUGIN_OCE_PATCH   3
#define	PLUGIN_OCE_REVNO   0

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

Variables
static struct FILE_DATA	file_data

Macro Definition Documentation

PLUGIN_OCE_MAJOR

#define PLUGIN_OCE_MAJOR   1

Definition at line 34 of file oce.cpp.

Referenced by GetPluginVersion().

PLUGIN_OCE_MINOR

#define PLUGIN_OCE_MINOR   4

Definition at line 35 of file oce.cpp.

Referenced by GetPluginVersion().

PLUGIN_OCE_PATCH

#define PLUGIN_OCE_PATCH   3

Definition at line 36 of file oce.cpp.

Referenced by GetPluginVersion().

PLUGIN_OCE_REVNO

#define PLUGIN_OCE_REVNO   0

Definition at line 37 of file oce.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 125 of file oce.cpp.

GetFileFilter()

char const * GetFileFilter

(

int

aIndex

)

Returns

the file filter string for the given index.

Definition at line 116 of file oce.cpp.

References file_data.

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 40 of file oce.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 101 of file oce.cpp.

References file_data.

GetNExtensions()

int GetNExtensions

(

void

)

Returns

the number of extensions supported by the plugin.

Definition at line 95 of file oce.cpp.

References file_data.

GetNFilters()

int GetNFilters

(

void

)

Returns

the number of file filters.

Definition at line 110 of file oce.cpp.

References file_data.

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 46 of file oce.cpp.

References PLUGIN_OCE_MAJOR, PLUGIN_OCE_MINOR, PLUGIN_OCE_PATCH, and PLUGIN_OCE_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 132 of file oce.cpp.

References ADVANCED_CFG::GetCfg(), LoadModel(), ADVANCED_CFG::m_OcePluginAngularDeflection, ADVANCED_CFG::m_OcePluginLinearDeflection, S3D::MODEL_IMPORT_OPTIONS::stepAngularDeflectionDegrees, and S3D::MODEL_IMPORT_OPTIONS::stepLinearDeflection.

Variable Documentation

file_data

struct FILE_DATA file_data

static