All Superinterfaces:: X3DChildNode, X3DNode, X3DUrlObject

All Known Implementing Classes:: FontLibrary

public interface FontLibrary extends X3DChildNode, X3DUrlObject

FontLibrary can load additional fonts for use by Text and FontStyle nodes.

FontLibrary node tooltip: (X3D version 4.1 draft) [X3DChildNode] FontLibrary can load additional fonts for use by Text and FontStyle nodes.

Hint: full Internationalization (i18n) and Localization (l10n) features are available for any written language.
Hint: supports capabilities for Web Internationalization (i18n) https://www.w3.org/standards/webdesign/i18n
Hint: Wikipedia https://en.wikipedia.org/wiki/Font
Hint: Wikipedia https://en.wikipedia.org/wiki/Typeface
Hint: open-source font libraries at https://fonts.google.com and https://fontlibrary.org
Warning: X3D Architecture version 4.1 draft is experimental and not fully implemented.

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

See Also:

Method Summary

Modifier and Type

Method

Description

double

getAutoRefresh()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.

double

getAutoRefreshTimeLimit()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.

String

getDescription()

Provide String value from inputOutput SFString field named description.

String

getFamily()

Provide String value from inputOutput SFString field named family.

boolean

getLoad()

Provide boolean value from inputOutput SFBool field named load.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

String[]

getUrl()

Provide array of String results from inputOutput MFString field named url.

FontLibrary

setAutoRefresh(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.

FontLibrary

setAutoRefreshTimeLimit(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.

FontLibrary

setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

FontLibrary

setFamily(String newValue)

Accessor method to assign String value to inputOutput SFString field named family.

FontLibrary

setLoad(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named load.

FontLibrary

setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

FontLibrary

setUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named url.

Method Details
- getAutoRefresh
  
  double getAutoRefresh()
  
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
  
  Tooltip: The [autoRefresh field has no effect, Anchor operation is only triggered by user selection. *
  
  Specified by:
  
  getAutoRefresh in interface X3DUrlObject
  
  Returns:
  
  value of autoRefresh field
- setAutoRefresh
  
  FontLibrary setAutoRefresh(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
  
  Tooltip: The [autoRefresh field has no effect, Anchor operation is only triggered by user selection. *
  
  Specified by:
  
  setAutoRefresh in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the autoRefresh field.
  
  Returns:
  
  FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getAutoRefreshTimeLimit
  
  double getAutoRefreshTimeLimit()
  
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
  
  Tooltip: The [autoRefreshTimeLimit field has no effect, Anchor operation is only triggered by user selection. *
  
  Specified by:
  
  getAutoRefreshTimeLimit in interface X3DUrlObject
  
  Returns:
  
  value of autoRefreshTimeLimit field
- setAutoRefreshTimeLimit
  
  FontLibrary setAutoRefreshTimeLimit(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
  
  Tooltip: The [autoRefreshTimeLimit field has no effect, Anchor operation is only triggered by user selection. *
  
  Specified by:
  
  setAutoRefreshTimeLimit in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the autoRefreshTimeLimit field.
  
  Returns:
  
  FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDescription
  String getDescription()
  
  Provide String value from inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose of the url asset.
  
  Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
  
  Specified by:
  
  getDescription in interface X3DUrlObject
  
  Returns:
  
  value of description field
- setDescription
  FontLibrary setDescription(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose of the url asset.
  
  Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
  
  Specified by:
  
  setDescription in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getFamily
  String getFamily()
  
  Provide String value from inputOutput SFString field named family.
  
  Tooltip: The family field provides an identifying alias for the font in the associated file, if that file only contains a single font family (possibly with multiple styles). This field provides a reference label for the family field in a corresponding FontStyle or ScreenFontStyle node. If no family field is provided, the X3D browser can look inside the font file to determine the family name of each associated font.
  
  Hint: this approach for family field is similar to how CSS can identify a font family associated with a font file for corresponding use in an HTML page.
  
  Hint: supports capabilities for Web Internationalization (i18n) https://www.w3.org/standards/webdesign/i18n
  
  Returns:
  
  value of family field
- setFamily
  FontLibrary setFamily(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named family.
  
  Tooltip: The family field provides an identifying alias for the font in the associated file, if that file only contains a single font family (possibly with multiple styles). This field provides a reference label for the family field in a corresponding FontStyle or ScreenFontStyle node. If no family field is provided, the X3D browser can look inside the font file to determine the family name of each associated font.
  
  Hint: this approach for family field is similar to how CSS can identify a font family associated with a font file for corresponding use in an HTML page.
  
  Hint: supports capabilities for Web Internationalization (i18n) https://www.w3.org/standards/webdesign/i18n
  
  Parameters:
  
  newValue - is new value for the family field.
  
  Returns:
  
  FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getLoad
  
  boolean getLoad()
  
  Provide boolean value from inputOutput SFBool field named load.
  
  Tooltip: The load field has no effect, Anchor operation is only triggered by user selection. *
  
  Specified by:
  
  getLoad in interface X3DUrlObject
  
  Returns:
  
  value of load field
- setLoad
  
  FontLibrary setLoad(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named load.
  
  Tooltip: The load field has no effect, Anchor operation is only triggered by user selection. *
  
  Specified by:
  
  setLoad in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the load field.
  
  Returns:
  
  FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getMetadata
  X3DMetadataObject getMetadata()
  
  Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
  
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  FontLibrary setMetadata(X3DMetadataObject newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- getUrl
  String[] getUrl()
  
  Provide array of String results from inputOutput MFString field named url.
  
  Tooltip: Address of replacement world, or #ViewpointDEFName within the current scene, or alternate Web resource, activated by the user selecting Shape geometry within the Anchor children nodes.
  
  Hint: jump to a world's internal viewpoint by appending viewpoint name (for example, #ViewpointName, someOtherCoolWorld.x3d#GrandTour).
  
  Hint: jump to a local viewpoint by only using viewpoint name (for example, #GrandTour).
  
  Hint: binding a different Viewpoint triggers an isBound event that can initiate other user-arrival reactions via event chains to interpolators or scripts.
  
  Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
  
  Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
  
  Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
  
  Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
  
  Hint: pop up a new window with url value as follows: "JavaScript:window.open('somePage.html','popup','width=240,height=240');location.href='HelloWorld.x3d'"
  
  Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
  
  Specified by:
  
  getUrl in interface X3DUrlObject
  
  Returns:
  
  value of url field
- setUrl
  FontLibrary setUrl(String[] newValue)
  
  Accessor method to assign String array to inputOutput MFString field named url.
  
  Tooltip: Address of replacement world, or #ViewpointDEFName within the current scene, or alternate Web resource, activated by the user selecting Shape geometry within the Anchor children nodes.
  
  Hint: jump to a world's internal viewpoint by appending viewpoint name (for example, #ViewpointName, someOtherCoolWorld.x3d#GrandTour).
  
  Hint: jump to a local viewpoint by only using viewpoint name (for example, #GrandTour).
  
  Hint: binding a different Viewpoint triggers an isBound event that can initiate other user-arrival reactions via event chains to interpolators or scripts.
  
  Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
  
  Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
  
  Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
  
  Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
  
  Hint: pop up a new window with url value as follows: "JavaScript:window.open('somePage.html','popup','width=240,height=240');location.href='HelloWorld.x3d'"
  
  Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
  
  Specified by:
  
  setUrl in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the url field.
  
  Returns:
  
  FontLibrary - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface FontLibrary

Method Summary

Method Details

getAutoRefresh

setAutoRefresh

getAutoRefreshTimeLimit

setAutoRefreshTimeLimit

getDescription

setDescription

getFamily

setFamily

getLoad

setLoad

getMetadata

setMetadata

getUrl

setUrl