EXPORTER_VRML Class Reference

Wrapper to expose an API for writing VRML files, without exposing all the many structures used in the actual exporter EXPORTER_PCB_VRML. More...

#include <export_vrml.h>

Public Member Functions
	EXPORTER_VRML (BOARD *aBoard)
	~EXPORTER_VRML ()
bool	ExportVRML_File (PROJECT *aProject, wxString *aMessages, const wxString &aFullFileName, double aMMtoWRMLunit, bool aIncludeUnspecified, bool aIncludeDNP, bool aExport3DFiles, bool aUseRelativePaths, const wxString &a3D_Subdir, double aXRef, double aYRef)
	Exports the board and its footprint shapes 3D (vrml files only) as a vrml file.

Private Attributes
EXPORTER_PCB_VRML *	pcb_exporter

Detailed Description

Wrapper to expose an API for writing VRML files, without exposing all the many structures used in the actual exporter EXPORTER_PCB_VRML.

Definition at line 32 of file export_vrml.h.

Constructor & Destructor Documentation

EXPORTER_VRML()

EXPORTER_VRML::EXPORTER_VRML

(

BOARD *

aBoard

)

Definition at line 55 of file exporter_vrml.cpp.

References pcb_exporter.

~EXPORTER_VRML()

EXPORTER_VRML::~EXPORTER_VRML

(

)

Definition at line 76 of file exporter_vrml.cpp.

References pcb_exporter.

Member Function Documentation

ExportVRML_File()

bool EXPORTER_VRML::ExportVRML_File	(	PROJECT *	aProject,
		wxString *	aMessages,
		const wxString &	aFullFileName,
		double	aMMtoWRMLunit,
		bool	aIncludeUnspecified,
		bool	aIncludeDNP,
		bool	aExport3DFiles,
		bool	aUseRelativePaths,
		const wxString &	a3D_Subdir,
		double	aXRef,
		double	aYRef
	)

Exports the board and its footprint shapes 3D (vrml files only) as a vrml file.

Parameters

aFullFileName	is the full filename of the board vrml file to create
aMMtoWRMLunit	is the convert factor from mm to the desired vrml file
aExport3DFiles	= true to copy 3D fp vrml models to a folder, and use " { inline fp_3d_model_filename }" keyword in vrml board file false to include them in the vrml board file
aUseRelativePaths	= true to use fp 3D relative paths, false to use absolute paths
a3D_Subdir	is the folder to copy 3D fp models
aXRef	= X position of board (in mm)
aYRef	= Y position of board (in mm)

Definition at line 61 of file exporter_vrml.cpp.

References EXPORTER_PCB_VRML::ExportVRML_File(), and pcb_exporter.

Referenced by PCB_EDIT_FRAME::ExportVRML_File(), and PCBNEW_JOBS_HANDLER::JobExportStep().

Member Data Documentation

pcb_exporter

EXPORTER_PCB_VRML* EXPORTER_VRML::pcb_exporter

private

Definition at line 60 of file export_vrml.h.

Referenced by EXPORTER_VRML(), ExportVRML_File(), and ~EXPORTER_VRML().

---

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

• export_vrml.h
• exporter_vrml.cpp