Package org.web3d.x3d.sai

Interface ProfileInfo

public interface ProfileInfo

Description of a single profile.

A profile is a short-hand way of describing an aggregation of components. A valid profile will always have one or more components, but a title string is optional.

Version:

$Revision: 1.3 $

Author:

Justin Couch

Method Summary

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

Method Details

getName

String getName()

Get the name of this component.

Returns:

name The name of the component

getTitle

String getTitle()

Get the title of this component. This is a long-form version that could be used in a UI. If no title is set, will return null.

Returns:

The title string of this component

getComponents

ComponentInfo[] getComponents()

Get the list of defined components for this profile. A profile will always have one or more components.

Returns:

An array of the component definitions for this profile

toX3DString

String toX3DString()

Return a formatted string version of this component that conforms to the X3D 1.0 specification for VRML file encoding. The string will start with the PROFILE keyword, as per spec.

Returns:

A correctly formatted string.