Skip to main content

ExporterClass

                            
                              
                                interface 
                                ExporterClass

The static interface for exporters.

Properties ​

displayName ​ 

                            
                              
                                readonly 
                                displayName
                                : 
                                string

The name of this exporter.

This name will be displayed in the editor.

id ​ 

                            
                              
                                readonly 
                                id
                                : 
                                string

The unique identifier of this exporter.

This identifier will be used to store the settings of this exporter.It's recommended to prepend it with the name of the package to avoidcollisions.

Methods ​

create ​ 

                            
                              
                                public 
                                create
                                
                                  
                                    
                                      project
                                      : 
                                      Project
                                    
                                    
                                      settings
                                      : 
                                      RendererSettings
                                    
                                  
                                
                                : 
                                Promise
                                
                                  
                                    
                                      Exporter

Create an instance of this exporter.

A new exporter is created whenever the user starts a new rendering process.

Parameters

  • project : Project

    The current project.

  • settings : RendererSettings

    The rendering settings.

meta ​ 

                            
                              
                                public 
                                meta
                                
                                  
                                    
                                      project
                                      : 
                                      Project
                                    
                                  
                                
                                : 
                                MetaField
                                
                                  
                                    
                                      any
                                    
                                    
                                      any

Create a meta field representing the options of this exporter.

Parameters