com.aspose.threed

Class Scene

java.lang.Object

com.aspose.threed.A3DObject

com.aspose.threed.SceneObject

com.aspose.threed.Scene

All Implemented Interfaces:

INamedObject

public class Scene
extends SceneObject

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION Gets the current release version

Fields inherited from class com.aspose.threed.A3DObject

name, properties

Constructor Summary

Constructors

Constructor and Description
Scene() Initializes a new instance of the Scene class.
Scene(Entity entity) Initializes a new instance of the Scene class with an entity attached to a new node.
Scene(Scene parentScene, java.lang.String name) Initializes a new instance of the Scene class as a sub-scene.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the scene content and restores the default settings.
AnimationClip	createAnimationClip(java.lang.String name) A shorthand function to create and register the AnimationClip The first AnimationClip will be assigned to the getCurrentAnimationClip()
static Scene	fromFile(java.lang.String fileName) Opens the scene from given path
static Scene	fromFile(java.lang.String fileName, Cancellation cancellationToken) Opens the scene from given path
static Scene	fromFile(java.lang.String fileName, FileFormat format) Opens the scene from given path using specified file format.
static Scene	fromFile(java.lang.String fileName, FileFormat format, Cancellation cancellationToken) Opens the scene from given path using specified file format.
static Scene	fromFile(java.lang.String fileName, LoadOptions options) Opens the scene from given path using specified file format.
static Scene	fromFile(java.lang.String fileName, LoadOptions options, Cancellation cancellationToken) Opens the scene from given path using specified file format.
static Scene	fromStream(java.io.InputStream stream) Opens the scene from given stream
static Scene	fromStream(java.io.InputStream stream, Cancellation cancellationToken) Opens the scene from given stream
static Scene	fromStream(java.io.InputStream stream, FileFormat format) Opens the scene from given stream using specified file format.
static Scene	fromStream(java.io.InputStream stream, FileFormat format, Cancellation cancellationToken) Opens the scene from given stream using specified file format.
static Scene	fromStream(java.io.InputStream stream, LoadOptions options) Opens the scene from given stream using specified IO config.
static Scene	fromStream(java.io.InputStream stream, LoadOptions options, Cancellation cancellationToken) Opens the scene from given stream using specified IO config.
static Scene	fromStream(Stream stream) Opens the scene from given stream
static Scene	fromStream(Stream stream, Cancellation cancellationToken) Opens the scene from given stream
static Scene	fromStream(Stream stream, FileFormat format) Opens the scene from given stream using specified file format.
static Scene	fromStream(Stream stream, FileFormat format, Cancellation cancellationToken) Opens the scene from given stream using specified file format.
static Scene	fromStream(Stream stream, LoadOptions options) Opens the scene from given stream using specified IO config.
static Scene	fromStream(Stream stream, LoadOptions options, Cancellation cancellationToken) Opens the scene from given stream using specified IO config.
AnimationClip	getAnimationClip(java.lang.String name) Gets a named AnimationClip
java.util.List<AnimationClip>	getAnimationClips() Gets all AnimationClip defined in the scene.
AssetInfo	getAssetInfo() Gets the top-level asset information
AnimationClip	getCurrentAnimationClip() Gets the active AnimationClip
java.util.List<A3DObject>	getLibrary() Objects that not directly used in scene hierarchy can be defined in Library.
java.util.Collection<Pose>	getPoses() Gets all Pose used in this scene.
Node	getRootNode() Gets the root node of the scene.
java.util.List<Scene>	getSubScenes() Gets all sub-scenes
void	open(java.io.InputStream stream) Opens the scene from given stream
void	open(java.io.InputStream stream, Cancellation cancellationToken) Opens the scene from given stream
void	open(java.io.InputStream stream, FileFormat format) Opens the scene from given stream using specified file format.
void	open(java.io.InputStream stream, FileFormat format, Cancellation cancellationToken) Opens the scene from given stream using specified file format.
void	open(java.io.InputStream stream, LoadOptions options) Opens the scene from given stream using specified IO config.
void	open(java.io.InputStream stream, LoadOptions options, Cancellation cancellationToken) Opens the scene from given stream using specified IO config.
void	open(Stream stream) Opens the scene from given stream
void	open(Stream stream, Cancellation cancellationToken) Opens the scene from given stream
void	open(Stream stream, FileFormat format) Opens the scene from given stream using specified file format.
void	open(Stream stream, FileFormat format, Cancellation cancellationToken) Opens the scene from given stream using specified file format.
void	open(Stream stream, LoadOptions options) Opens the scene from given stream using specified IO config.
void	open(Stream stream, LoadOptions options, Cancellation cancellationToken) Opens the scene from given stream using specified IO config.
void	open(java.lang.String fileName) Opens the scene from given path
void	open(java.lang.String fileName, Cancellation cancellationToken) Opens the scene from given path
void	open(java.lang.String fileName, FileFormat format) Opens the scene from given path using specified file format.
void	open(java.lang.String fileName, FileFormat format, Cancellation cancellationToken) Opens the scene from given path using specified file format.
void	open(java.lang.String fileName, LoadOptions options) Opens the scene from given path using specified file format.
void	open(java.lang.String fileName, LoadOptions options, Cancellation cancellationToken) Opens the scene from given path using specified file format.
void	save(java.io.OutputStream stream, FileFormat format) Saves the scene to stream using specified file format.
void	save(java.io.OutputStream stream, FileFormat format, Cancellation cancellationToken) Saves the scene to stream using specified file format.
void	save(java.io.OutputStream stream, SaveOptions options) Saves the scene to stream using specified file format.
void	save(java.io.OutputStream stream, SaveOptions options, Cancellation cancellationToken) Saves the scene to stream using specified file format.
void	save(Stream stream, FileFormat format) Saves the scene to stream using specified file format.
void	save(Stream stream, FileFormat format, Cancellation cancellationToken) Saves the scene to stream using specified file format.
void	save(Stream stream, SaveOptions options) Saves the scene to stream using specified file format.
void	save(Stream stream, SaveOptions options, Cancellation cancellationToken) Saves the scene to stream using specified file format.
void	save(java.lang.String fileName) Saves the scene to specified path using specified file format.
void	save(java.lang.String fileName, FileFormat format) Saves the scene to specified path using specified file format.
void	save(java.lang.String fileName, FileFormat format, Cancellation cancellationToken) Saves the scene to specified path using specified file format.
void	save(java.lang.String fileName, SaveOptions options) Saves the scene to specified path using specified file format.
void	save(java.lang.String fileName, SaveOptions options, Cancellation cancellationToken) Saves the scene to specified path using specified file format.
void	setAssetInfo(AssetInfo value) Sets the top-level asset information
void	setCurrentAnimationClip(AnimationClip value) Sets the active AnimationClip

Methods inherited from class com.aspose.threed.SceneObject

getScene

Methods inherited from class com.aspose.threed.A3DObject

findProperty, getName, getProperties, getProperty, removeProperty, removeProperty, setName, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final java.lang.String VERSION

Gets the current release version

See Also:

Constant Field Values

Constructor Detail

Scene

public Scene(Entity entity)

Initializes a new instance of the Scene class with an entity attached to a new node.

Parameters:

entity - The initial entity that attached to the scene Example: The following code shows how to create a SceneObject.getScene() directly from an Entity:

  var scene = new Scene(new Box());
 

Scene

public Scene(Scene parentScene,
             java.lang.String name)

Initializes a new instance of the Scene class as a sub-scene.

Parameters:

parentScene - The parent scene.

name - Scene's name.

Scene

public Scene()

Initializes a new instance of the Scene class.

Method Detail

fromStream

public static Scene fromStream(java.io.InputStream stream,
                               FileFormat format,
                               Cancellation cancellationToken)
                        throws java.io.IOException

Opens the scene from given stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - File format.

cancellationToken - Cancellation token to the load task Example: The following code shows how to create a scene from a stream

    
      try(InputStream input = new FileInputStream("input.fbx")) {    
          Scene scene = Scene.fromStream(input);    
      }    
 

Throws:

java.io.IOException

fromStream

public static Scene fromStream(java.io.InputStream stream,
                               FileFormat format)
                        throws java.io.IOException

Opens the scene from given stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - File format. Example: The following code shows how to create a scene from a stream

    
      try(InputStream input = new FileInputStream("input.fbx")) {    
          Scene scene = Scene.fromStream(input);    
      }    
 

Throws:

java.io.IOException

fromStream

public static Scene fromStream(java.io.InputStream stream,
                               LoadOptions options,
                               Cancellation cancellationToken)
                        throws java.io.IOException

Opens the scene from given stream using specified IO config.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to open the stream.

cancellationToken - Cancellation token to the load task Example: The following code shows how to create a scene from a stream with load options

    
     var opts = new FbxLoadOptions();    
     opts.getLookupPaths().add("textures");    
     try(InputStream input = new FileInputStream("input.fbx")) {    
         Scene scene = Scene.fromStream(input, opts);    
      }    
 

Throws:

java.io.IOException

fromStream

public static Scene fromStream(java.io.InputStream stream,
                               LoadOptions options)
                        throws java.io.IOException

Opens the scene from given stream using specified IO config.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to open the stream. Example: The following code shows how to create a scene from a stream with load options

    
     var opts = new FbxLoadOptions();    
     opts.getLookupPaths().add("textures");    
     try(InputStream input = new FileInputStream("input.fbx")) {    
         Scene scene = Scene.fromStream(input, opts);    
      }    
 

Throws:

java.io.IOException

fromStream

public static Scene fromStream(java.io.InputStream stream,
                               Cancellation cancellationToken)
                        throws java.io.IOException

Opens the scene from given stream

Parameters:

stream - Input stream, user is responsible for closing the stream.

cancellationToken - Cancellation token to the load task Example: The following code shows how to create a scene from a stream with a cancellation token source

    
     var cts = new Cancellation();    
     try(InputStream input = new FileInputStream("input.fbx")) {    
         Scene scene = Scene.fromStream(input, cts);    
      }    
 

Throws:

java.io.IOException

fromStream

public static Scene fromStream(java.io.InputStream stream)
                        throws java.io.IOException

Opens the scene from given stream

Parameters:

stream - Input stream, user is responsible for closing the stream. Example: The following code shows how to create a scene from a stream with a cancellation token source

    
     var cts = new Cancellation();    
     try(InputStream input = new FileInputStream("input.fbx")) {    
         Scene scene = Scene.fromStream(input);    
      }    
 

Throws:

java.io.IOException

open

public void open(java.io.InputStream stream,
                 FileFormat format,
                 Cancellation cancellationToken)
          throws java.io.IOException

Opens the scene from given stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - File format.

cancellationToken - Cancellation token to the load task Example: The following code shows how to open a scene from stream

    
     Scene scene = new Scene();    
     try(var fs = new FileInputStream("input.fbx")) {    
         scene.open(fs, FileFormat.GLTF2);    
     }    
 

Throws:

java.io.IOException

open

public void open(java.io.InputStream stream,
                 FileFormat format)
          throws java.io.IOException

Opens the scene from given stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - File format. Example: The following code shows how to open a scene from stream

    
     Scene scene = new Scene();    
     try(var fs = new FileInputStream("input.fbx")) {    
         scene.open(fs, FileFormat.GLTF2);    
     }    
 

Throws:

java.io.IOException

open

public void open(java.io.InputStream stream,
                 LoadOptions options,
                 Cancellation cancellationToken)
          throws java.io.IOException

Opens the scene from given stream using specified IO config.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to open the stream.

cancellationToken - Cancellation token to the load task Example: The following code shows how to open a scene from stream with extra load options

    
     Scene scene = new Scene();    
     try(var fs = new FileInputStream("input.fbx")) {    
         var opt = new FbxLoadOptions();    
         opt.getLookupPaths().add("textures");    
         scene.open(fs, opt);    
     }    
 

Throws:

java.io.IOException

open

public void open(java.io.InputStream stream,
                 LoadOptions options)
          throws java.io.IOException

Opens the scene from given stream using specified IO config.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to open the stream. Example: The following code shows how to open a scene from stream with extra load options

    
     Scene scene = new Scene();    
     try(var fs = new FileInputStream("input.fbx")) {    
         var opt = new FbxLoadOptions();    
         opt.getLookupPaths().add("textures");    
         scene.open(fs, opt);    
     }    
 

Throws:

java.io.IOException

open

public void open(java.io.InputStream stream)
          throws java.io.IOException

Opens the scene from given stream

Parameters:

stream - Input stream, user is responsible for closing the stream. Example: The following code shows how to open a scene from stream

    
     var scene = new Scene();    
     try(var fs = new FileInputStream("input.fbx")) {    
         scene.open(fs);    
     }    
 

Throws:

java.io.IOException

open

public void open(java.io.InputStream stream,
                 Cancellation cancellationToken)
          throws java.io.IOException

Opens the scene from given stream

Parameters:

stream - Input stream, user is responsible for closing the stream.

cancellationToken - Cancellation token to the load task Example: The following code shows how to open a scene from stream with a cancellation token

    
     var scene = new Scene();    
     Cancellation cts = new Cancellation();    
     try(var fs = new FileInputStream("input.fbx")) {    
         scene.open(fs, cts);    
     }    
 

Throws:

java.io.IOException

save

public void save(java.io.OutputStream stream,
                 FileFormat format)
          throws java.io.IOException

Saves the scene to stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - Format. Example: The following code shows how to save scene

    
     Scene scene = Scene.fromFile("input.fbx");    
     try(var ms = new ByteArrayOutputStream())    
     {    
         scene.save(ms, FileFormat.USDZ);    
     }    
 

Throws:

java.io.IOException

save

public void save(java.io.OutputStream stream,
                 FileFormat format,
                 Cancellation cancellationToken)
          throws java.io.IOException

Saves the scene to stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - Format.

cancellationToken - Cancellation token to the save task Example: The following code shows how to save scene

    
     Scene scene = Scene.fromFile("input.fbx");    
     var cts = new Cancellation();    
     try(var ms = new ByteArrayOutputStream())    
     {    
         scene.save(ms, FileFormat.USDZ, cts);    
     }    
 

Throws:

java.io.IOException

save

public void save(java.io.OutputStream stream,
                 SaveOptions options)
          throws java.io.IOException

Saves the scene to stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to save the stream. Example: The following code shows how to save scene

    
     Scene scene = Scene.fromFile("input.fbx");    
     var opt = new UsdSaveOptions();    
     opt.setPrimitiveToMesh(true);    
     try(var ms = new ByteArrayOutputStream())    
     {    
         scene.save(ms, opt);    
     }    
 

Throws:

java.io.IOException

save

public void save(java.io.OutputStream stream,
                 SaveOptions options,
                 Cancellation cancellationToken)
          throws java.io.IOException

Saves the scene to stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to save the stream.

cancellationToken - Cancellation token to the save task Example: The following code shows how to save scene

    
     Scene scene = Scene.fromFile("input.fbx");    
     var cts = new Cancellation();    
     var opt = new UsdSaveOptions();    
     opt.setPrimitiveToMesh(true);    
     try(var ms = new ByteArrayOutputStream())    
     {    
         scene.save(ms, opt, cts);    
     }    
 

Throws:

java.io.IOException

getSubScenes

public java.util.List<Scene> getSubScenes()

Gets all sub-scenes

Returns:

all sub-scenes

getLibrary

public java.util.List<A3DObject> getLibrary()

Objects that not directly used in scene hierarchy can be defined in Library. This is useful when you're using sub-scenes and put reusable components under sub-scenes.

Returns:

Objects that not directly used in scene hierarchy can be defined in Library. This is useful when you're using sub-scenes and put reusable components under sub-scenes.

getAnimationClips

public java.util.List<AnimationClip> getAnimationClips()

Gets all AnimationClip defined in the scene.

Returns:

all AnimationClip defined in the scene.

getCurrentAnimationClip

public AnimationClip getCurrentAnimationClip()

Gets the active AnimationClip

Returns:

the active AnimationClip

setCurrentAnimationClip

public void setCurrentAnimationClip(AnimationClip value)

Sets the active AnimationClip

Parameters:

value - New value

getAnimationClip

public AnimationClip getAnimationClip(java.lang.String name)

Gets a named AnimationClip

Parameters:

name - The AnimationClip's name to look up

Returns:

Returned AnimationClip

getAssetInfo

public AssetInfo getAssetInfo()

Gets the top-level asset information

Returns:

the top-level asset information Example: The following code shows how to read the application information from a FBX file:

     Scene scene = Scene.fromFile("test.fbx");
     System.out.printf("The FBX file is created by %s %s",
         scene.getAssetInfo().getApplicationName(),
         scene.getAssetInfo().getApplicationVersion());
 

setAssetInfo

public void setAssetInfo(AssetInfo value)

Sets the top-level asset information

Parameters:

value - New value Example: The following code shows how to read the application information from a FBX file:

     Scene scene = Scene.fromFile("test.fbx");
     System.out.printf("The FBX file is created by %s %s",
         scene.getAssetInfo().getApplicationName(),
         scene.getAssetInfo().getApplicationVersion());
 

getPoses

public java.util.Collection<Pose> getPoses()

Gets all Pose used in this scene.

Returns:

all Pose used in this scene.

getRootNode

public Node getRootNode()

Gets the root node of the scene.

Returns:

the root node of the scene. Example: The following code shows how to create a node with Box entity attached to the root node.

     Scene scene = new Scene();
     scene.getRootNode().createChildNode(new Box());
     scene.save("box.stl");
 

clear

public void clear()

Clears the scene content and restores the default settings.

createAnimationClip

public AnimationClip createAnimationClip(java.lang.String name)

A shorthand function to create and register the AnimationClip The first AnimationClip will be assigned to the getCurrentAnimationClip()

Parameters:

name - Animation clip's name

Returns:

A new animation clip instance with given name

open

public void open(Stream stream,
                 FileFormat format,
                 Cancellation cancellationToken)
          throws java.io.IOException

Opens the scene from given stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - File format.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from stream

     Scene scene = new Scene();
     try(var fs = new FileInputStream("input.fbx")) {
         try (var stream = Stream.wrap(fs)) {
             scene.open(stream, FileFormat.GLTF2);
         }
     }
 

open

public void open(Stream stream,
                 FileFormat format)
          throws java.io.IOException

Opens the scene from given stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - File format.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from stream

     Scene scene = new Scene();
     try(var fs = new FileInputStream("input.fbx")) {
         try (var stream = Stream.wrap(fs)) {
             scene.open(stream, FileFormat.GLTF2);
         }
     }
 

open

public void open(Stream stream,
                 LoadOptions options,
                 Cancellation cancellationToken)
          throws java.io.IOException

Opens the scene from given stream using specified IO config.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to open the stream.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from stream with extra load options

     Scene scene = new Scene();
     try(var fs = new FileInputStream("input.fbx")) {
         try (var stream = Stream.wrap(fs)) {
             var opt = new FbxLoadOptions();
             opt.getLookupPaths().add("textures");
             scene.open(stream, opt);
         }
     }
 

open

public void open(Stream stream,
                 LoadOptions options)
          throws java.io.IOException

Opens the scene from given stream using specified IO config.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to open the stream.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from stream with extra load options

     Scene scene = new Scene();
     try(var fs = new FileInputStream("input.fbx")) {
         try (var stream = Stream.wrap(fs)) {
             var opt = new FbxLoadOptions();
             opt.getLookupPaths().add("textures");
             scene.open(stream, opt);
         }
     }
 

open

public void open(Stream stream)
          throws java.io.IOException

Opens the scene from given stream

Parameters:

stream - Input stream, user is responsible for closing the stream.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from stream

     var scene = new Scene();
     try(var fs = new FileInputStream("input.fbx")) {
         try (var stream = Stream.wrap(fs)) {
             scene.open(stream);
         }
     }
 

open

public void open(Stream stream,
                 Cancellation cancellationToken)
          throws java.io.IOException

Opens the scene from given stream

Parameters:

stream - Input stream, user is responsible for closing the stream.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from stream with a cancellation token

     var scene = new Scene();
     Cancellation cts = new Cancellation();
     try(var fs = new FileInputStream("input.fbx")) {
         try (var stream = Stream.wrap(fs)) {
             scene.open(stream, cts);
         }
     }
 

open

public void open(java.lang.String fileName,
                 FileFormat format,
                 Cancellation cancellationToken)
          throws java.io.IOException

Opens the scene from given path using specified file format.

Parameters:

fileName - File name.

format - File format.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from file name with a cancellation token

     Scene scene = new Scene();
     Cancellation cts = new Cancellation();
     scene.open("input.fbx", FileFormat.FBX7400ASCII, cts);
 

open

public void open(java.lang.String fileName,
                 FileFormat format)
          throws java.io.IOException

Opens the scene from given path using specified file format.

Parameters:

fileName - File name.

format - File format.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from file name with a cancellation token

     Scene scene = new Scene();
     Cancellation cts = new Cancellation();
     scene.open("input.fbx", FileFormat.FBX7400ASCII, cts);
 

open

public void open(java.lang.String fileName,
                 LoadOptions options)
          throws java.io.IOException

Opens the scene from given path using specified file format.

Parameters:

fileName - File name.

options - More detailed configuration to open the stream.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from file name with extra load options

     Scene scene = new Scene();
     var opts = new FbxLoadOptions();
     opts.getLookupPaths().add("textures");
     scene.open("input.fbx", opts);
 

open

public void open(java.lang.String fileName,
                 LoadOptions options,
                 Cancellation cancellationToken)
          throws java.io.IOException

Opens the scene from given path using specified file format.

Parameters:

fileName - File name.

options - More detailed configuration to open the stream.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from file name with extra load options and cancellation token

     var cts = new Cancellation();
     Scene scene = new Scene();
     var opts = new FbxLoadOptions();
     opts.getLookupPaths().add("textures");
     scene.Open("input.fbx", opts, cts);
 

open

public void open(java.lang.String fileName)
          throws java.io.IOException

Opens the scene from given path

Parameters:

fileName - File name.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from file name

     Scene scene = new Scene();
     scene.open("input.fbx");
 

open

public void open(java.lang.String fileName,
                 Cancellation cancellationToken)
          throws java.io.IOException

Opens the scene from given path

Parameters:

fileName - File name.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to open a scene from file name and a cancellation token source

     var cts = new Cancellation();
     Scene scene = new Scene();
     scene.open("input.fbx", cts);
 

fromStream

public static Scene fromStream(Stream stream,
                               FileFormat format,
                               Cancellation cancellationToken)
                        throws java.io.IOException

Opens the scene from given stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - File format.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a stream

      try(InputStream input = new FileInputStream("input.fbx")) {
          try(Stream stream = Stream.wrap(input)) {
              Scene scene = Scene.fromStream(stream);
          }
      }
 

fromStream

public static Scene fromStream(Stream stream,
                               FileFormat format)
                        throws java.io.IOException

Opens the scene from given stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - File format.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a stream

      try(InputStream input = new FileInputStream("input.fbx")) {
          try(Stream stream = Stream.wrap(input)) {
              Scene scene = Scene.fromStream(stream);
          }
      }
 

fromStream

public static Scene fromStream(Stream stream,
                               LoadOptions options,
                               Cancellation cancellationToken)
                        throws java.io.IOException

Opens the scene from given stream using specified IO config.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to open the stream.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a stream with load options

     var opts = new FbxLoadOptions();
     opts.getLookupPaths().add("textures");
     try(InputStream input = new FileInputStream("input.fbx")) {
         try(Stream stream = Stream.wrap(input)) {
             Scene scene = Scene.fromStream(stream, opts);
         }
      }
 

fromStream

public static Scene fromStream(Stream stream,
                               LoadOptions options)
                        throws java.io.IOException

Opens the scene from given stream using specified IO config.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to open the stream.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a stream with load options

     var opts = new FbxLoadOptions();
     opts.getLookupPaths().add("textures");
     try(InputStream input = new FileInputStream("input.fbx")) {
         try(Stream stream = Stream.wrap(input)) {
             Scene scene = Scene.fromStream(stream, opts);
         }
      }
 

fromStream

public static Scene fromStream(Stream stream,
                               Cancellation cancellationToken)
                        throws java.io.IOException

Opens the scene from given stream

Parameters:

stream - Input stream, user is responsible for closing the stream.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a stream with a cancellation token source

     var cts = new Cancellation();
     try(InputStream input = new FileInputStream("input.fbx")) {
         try(Stream stream = Stream.wrap(input)) {
             Scene scene = Scene.fromStream(stream, cts);
         }
      }
 

fromStream

public static Scene fromStream(Stream stream)
                        throws java.io.IOException

Opens the scene from given stream

Parameters:

stream - Input stream, user is responsible for closing the stream.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a stream with a cancellation token source

     var cts = new Cancellation();
     try(InputStream input = new FileInputStream("input.fbx")) {
         try(Stream stream = Stream.wrap(input)) {
             Scene scene = Scene.fromStream(stream, cts);
         }
      }
 

fromFile

public static Scene fromFile(java.lang.String fileName,
                             FileFormat format,
                             Cancellation cancellationToken)
                      throws java.io.IOException

Opens the scene from given path using specified file format.

Parameters:

fileName - File name.

format - File format.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a file

     var cts = new Cancellation();
     Scene scene = Scene.fromFile("input.fbx", FileFormat.FBX7400ASCII, cts);
 

fromFile

public static Scene fromFile(java.lang.String fileName,
                             FileFormat format)
                      throws java.io.IOException

Opens the scene from given path using specified file format.

Parameters:

fileName - File name.

format - File format.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a file

     var cts = new Cancellation();
     Scene scene = Scene.fromFile("input.fbx", FileFormat.FBX7400ASCII, cts);
 

fromFile

public static Scene fromFile(java.lang.String fileName,
                             LoadOptions options,
                             Cancellation cancellationToken)
                      throws java.io.IOException

Opens the scene from given path using specified file format.

Parameters:

fileName - File name.

options - More detailed configuration to open the stream.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a file

     var cts = new Cancellation();
     var opt = new FbxLoadOptions();
     opt.getLookupPaths().add("textures");
     Scene scene = Scene.fromFile("input.fbx", opt, cts);
 

fromFile

public static Scene fromFile(java.lang.String fileName,
                             LoadOptions options)
                      throws java.io.IOException

Opens the scene from given path using specified file format.

Parameters:

fileName - File name.

options - More detailed configuration to open the stream.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a file

     var cts = new Cancellation();
     var opt = new FbxLoadOptions();
     opt.getLookupPaths().add("textures");
     Scene scene = Scene.fromFile("input.fbx", opt, cts);
 

fromFile

public static Scene fromFile(java.lang.String fileName)
                      throws java.io.IOException

Opens the scene from given path

Parameters:

fileName - File name.

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a file

     Scene scene = Scene.fromFile("input.fbx");
 

fromFile

public static Scene fromFile(java.lang.String fileName,
                             Cancellation cancellationToken)
                      throws java.io.IOException

Opens the scene from given path

Parameters:

fileName - File name.

cancellationToken - Cancellation token to the load task

Throws:

java.io.IOException - Thrown when failed at reading input

ImportException - Thrown when input is not a valid 3D format Example: The following code shows how to create a scene from a file

     var cts = new Cancellation();
     Scene scene = Scene.fromFile("input.fbx", cts);
 

save

public void save(Stream stream,
                 FileFormat format)
          throws java.io.IOException

Saves the scene to stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - Format.

Throws:

java.io.IOException - Thrown when failed at reading input

ExportException - Thrown when failed to export the scene to specified 3D format Example: The following code shows how to save scene

     Scene scene = Scene.fromFile("input.fbx");
     try(var ms = new ByteArrayOutputStream())
     {
         scene.save(ms, FileFormat.USDZ);
     }
 

save

public void save(Stream stream,
                 FileFormat format,
                 Cancellation cancellationToken)
          throws java.io.IOException

Saves the scene to stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

format - Format.

cancellationToken - Cancellation token to the save task

Throws:

java.io.IOException - Thrown when failed at reading input

ExportException - Thrown when failed to export the scene to specified 3D format Example: The following code shows how to save scene

     Scene scene = Scene.fromFile("input.fbx");
     var cts = new Cancellation();
     try(var ms = new ByteArrayOutputStream())
     {
         scene.save(ms, FileFormat.USDZ, cts);
     }
 

save

public void save(Stream stream,
                 SaveOptions options)
          throws java.io.IOException

Saves the scene to stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to save the stream.

Throws:

java.io.IOException - Thrown when failed at reading input

ExportException - Thrown when failed to export the scene to specified 3D format Example: The following code shows how to save scene

     Scene scene = Scene.fromFile("input.fbx");
     var opt = new UsdSaveOptions();
     opt.setPrimitiveToMesh(true);
     try(var ms = new ByteArrayOutputStream())
     {
         scene.save(ms, opt);
     }
 

save

public void save(Stream stream,
                 SaveOptions options,
                 Cancellation cancellationToken)
          throws java.io.IOException

Saves the scene to stream using specified file format.

Parameters:

stream - Input stream, user is responsible for closing the stream.

options - More detailed configuration to save the stream.

cancellationToken - Cancellation token to the save task

Throws:

java.io.IOException - Thrown when failed at reading input

ExportException - Thrown when failed to export the scene to specified 3D format Example: The following code shows how to save scene

     Scene scene = Scene.fromFile("input.fbx");
     var cts = new Cancellation();
     var opt = new UsdSaveOptions();
     opt.setPrimitiveToMesh(true);
     try(var ms = new ByteArrayOutputStream())
     {
         scene.save(ms, opt, cts);
     }
 

save

public void save(java.lang.String fileName)
          throws java.io.IOException

Saves the scene to specified path using specified file format.

Parameters:

fileName - File name.

Throws:

java.io.IOException - Thrown when failed at reading input

ExportException - Thrown when failed to export the scene to specified 3D format Example: The following code shows how to save scene

     Scene scene = Scene.fromFile("input.fbx");
     scene.save("output.usdz");
 

save

public void save(java.lang.String fileName,
                 FileFormat format)
          throws java.io.IOException

Saves the scene to specified path using specified file format.

Parameters:

fileName - File name.

format - Format.

Throws:

java.io.IOException - Thrown when failed at reading input

ExportException - Thrown when failed to export the scene to specified 3D format Example: The following code shows how to save scene

     Scene scene = Scene.fromFile("input.fbx");
     scene.save("output.usdz", FileFormat.USDZ);
 

save

public void save(java.lang.String fileName,
                 FileFormat format,
                 Cancellation cancellationToken)
          throws java.io.IOException

Saves the scene to specified path using specified file format.

Parameters:

fileName - File name.

format - Format.

cancellationToken - Cancellation token to the save task

Throws:

java.io.IOException - Thrown when failed at reading input

ExportException - Thrown when failed to export the scene to specified 3D format Example: The following code shows how to save scene

     var cts = new Cancellation();
     Scene scene = Scene.fromFile("input.fbx");
     scene.save("output.usdz", FileFormat.USDZ, cts);
 

save

public void save(java.lang.String fileName,
                 SaveOptions options)
          throws java.io.IOException

Saves the scene to specified path using specified file format.

Parameters:

fileName - File name.

options - More detailed configuration to save the stream.

Throws:

java.io.IOException - Thrown when failed at reading input

ExportException - Thrown when failed to export the scene to specified 3D format Example: The following code shows how to save scene

     var scene = Scene.fromFile("input.fbx");
     var opts = new UsdSaveOptions();
     opts.setPrimitiveToMesh(true);
     scene.save("output.usdz", opts);
 

save

public void save(java.lang.String fileName,
                 SaveOptions options,
                 Cancellation cancellationToken)
          throws java.io.IOException

Saves the scene to specified path using specified file format.

Parameters:

fileName - File name.

options - More detailed configuration to save the stream.

cancellationToken - Cancellation token to the save task

Throws:

java.io.IOException - Thrown when failed at reading input

ExportException - Thrown when failed to export the scene to specified 3D format Example: The following code shows how to save scene

     var cts = new Cancellation();
     var scene = Scene.fromFile("input.fbx");
     var opts = new UsdSaveOptions();
     opts.setPrimitiveToMesh(true);
     scene.save("output.usdz", opts, cts);