Package org.web3d.x3d.sai

Interface X3DComponent

public interface X3DComponent
Abstract node interface, defined by X3D Java Scene Access Interface (SAI) Specification to support X3D Java interoperability.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

Provides for implementation of a X3D player than runs as a component and able to extract a Browser reference from it.

Generally this is used to provide a definition of an AWT component with a VRML/X3D display capability. There is no reason why this can not be used for other browser representations such as off-screen renderers or file savers.

See Also:
SAI Java Specification: B.5.2 BrowserFactory, X3D Tooltips, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    ExternalBrowser getBrowser()
    Get a browser reference from this component that represents the internals of this browser.
    java.lang.Object getImplementation()
    Get a reference to the component implementation.
    void shutdown()
    Shutdown the component because it will no longer be needed.

  • Method Details

    • getBrowser

      ExternalBrowser getBrowser()
      Get a browser reference from this component that represents the internals of this browser.
      Returns:
      A reference to the browser object represented by this component.

    • getImplementation

      java.lang.Object getImplementation()
      Get a reference to the component implementation. For example, if this is an AWT component, it would return an instance of Component.
      Returns:
      a reference to the component implementation

    • shutdown

      void shutdown()
      Shutdown the component because it will no longer be needed. If the component has already had this method called, it will silently ignore any further requests.