Package org.web3d.x3d.sai

Interface ProfileInfo

public interface ProfileInfo
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). Description of a single profile, which is a collection of components. A profile defines the player or tool support needed for a particular scene.
See Also:
SAI Java Specification: B.6.2 ProfileInfo, X3D Abstract Specification: 7.2.5.3 PROFILE statement, X3D Tooltips: ProfileInfo, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    Component[] getComponents()
    Get the list of defined components for this profile.
    java.lang.String getName()
    Get the name of this component.
    java.lang.String getTitle()
    Get the title of this component.
    java.lang.String toX3DString()
    Return a formatted string version of this component that conforms to the X3D specification for X3D file encoding.

  • Method Details

    • getName

      java.lang.String getName()
      Get the name of this component.
      Returns:
      name The name of the component

    • getTitle

      java.lang.String getTitle()
      Get the title of this component. This is a long-form version that can be used in a UI.
      Returns:
      The title string of this component

    • getComponents

      Component[] getComponents()
      Get the list of defined components for this profile. A profile will always have one or more components.
      Returns:
      An array of Component definitions for this profile

    • toX3DString

      java.lang.String toX3DString()
      Return a formatted string version of this component that conforms to the X3D specification for X3D file encoding. The string will start with the PROFILE keyword, as per specification.
      Returns:
      A correctly formatted string