org.web3d.x3d.jsail.Networking.Anchor

All Implemented Interfaces:: X3DChildNode, X3DNode, X3DBoundedObject, X3DGroupingNode, Anchor, X3DUrlObject

public class Anchor extends X3DConcreteNode implements Anchor

Anchor is a Grouping node that can contain most nodes.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. Anchor node tooltip: [X3DGroupingNode,X3DUrlObject,X3DVisibleObject] Anchor is a Grouping node that can contain most nodes. When the user selects any of the geometry contained by the Anchor node, the browser either jumps to another viewpoint (similar to HTML bookmark) or else loads content (such as X3D, an image or HTML) specified by the url field. Newly loaded content completely replaces current content, if the value of parameter field indicates using the same window.

Hint: insert a Shape node before adding geometry or Appearance.
Hint: when parent node is LoadSensor, apply containerField='children' (X3Dv4) or containerField='watchList' (X3Dv3). https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

static final double

AUTOREFRESH_DEFAULT_VALUE

SFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).

static final double

AUTOREFRESHTIMELIMIT_DEFAULT_VALUE

SFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).

static final float[]

BBOXCENTER_DEFAULT_VALUE

SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

static final boolean

BBOXDISPLAY_DEFAULT_VALUE

SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).

static final float[]

BBOXSIZE_DEFAULT_VALUE

SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).

static final String

COMPONENT

String constant COMPONENT defines X3D component for the Anchor element: Networking

static final String

containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent.

static final String

DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

static final String

fromField_AUTOREFRESH

fromField ROUTE name for SFTime field named autoRefresh.

static final String

fromField_AUTOREFRESHTIMELIMIT

fromField ROUTE name for SFTime field named autoRefreshTimeLimit.

static final String

fromField_BBOXDISPLAY

fromField ROUTE name for SFBool field named bboxDisplay.

static final String

fromField_CHILDREN

fromField ROUTE name for MFNode field named children.

static final String

fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

static final String

fromField_IS

fromField ROUTE name for SFNode field named IS.

static final String

fromField_LOAD

fromField ROUTE name for SFBool field named load.

static final String

fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

static final String

fromField_PARAMETER

fromField ROUTE name for MFString field named parameter.

static final String

fromField_URL

fromField ROUTE name for MFString field named url.

static final String

fromField_VISIBLE

fromField ROUTE name for SFBool field named visible.

static final IS

IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

static final int

LEVEL

Integer constant LEVEL provides default X3D Networking component level for this element: 2

static final boolean

LOAD_DEFAULT_VALUE

SFBool field named load has default value true (Java syntax) or true (XML syntax).

static final X3DMetadataObject

METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

static final String

NAME

String constant NAME provides name of this element: Anchor.

static final ArrayList<String>

PARAMETER_DEFAULT_VALUE

MFString field named parameter has default value equal to an empty list.

static final String

toField_ADDCHILDREN

toField ROUTE name for MFNode field named addChildren.

static final String

toField_AUTOREFRESH

toField ROUTE name for SFTime field named autoRefresh.

static final String

toField_AUTOREFRESHTIMELIMIT

toField ROUTE name for SFTime field named autoRefreshTimeLimit.

static final String

toField_BBOXDISPLAY

toField ROUTE name for SFBool field named bboxDisplay.

static final String

toField_CHILDREN

toField ROUTE name for MFNode field named children.

static final String

toField_DESCRIPTION

toField ROUTE name for SFString field named description.

static final String

toField_LOAD

toField ROUTE name for SFBool field named load.

static final String

toField_METADATA

toField ROUTE name for SFNode field named metadata.

static final String

toField_PARAMETER

toField ROUTE name for MFString field named parameter.

static final String

toField_REMOVECHILDREN

toField ROUTE name for MFNode field named removeChildren.

static final String

toField_URL

toField ROUTE name for MFString field named url.

static final String

toField_VISIBLE

toField ROUTE name for SFBool field named visible.

static final ArrayList<String>

URL_DEFAULT_VALUE

MFString field named url has default value equal to an empty list.

static final boolean

VISIBLE_DEFAULT_VALUE

SFBool field named visible has default value true (Java syntax) or true (XML syntax).

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
Constructor Summary

Constructors

Constructor

Description

Anchor()

Constructor for Anchor to initialize member variables with default values.

Anchor(String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.
Method Summary

Modifier and Type

Method

Description

Anchor

addChild(X3DChildNode newValue)

Utility method to add single child element to contained list of existing children nodes (if any).

Anchor

addChildren(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.

void

addChildren(X3DNode newValue)

Add single node to existing array of children nodes (if any).

void

addChildren(X3DNode[] newValue)

Add array of children nodes to array of existing nodes (if any).

Anchor

addComments(String newComment)

Add comment as CommentsBlock to children field

Anchor

addComments(String[] newComments)

Add comments as String[] array to children field

Anchor

addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to children field

Anchor

addParameter(String newValue)

Add singleton String value to MFString parameter field.

Anchor

addParameter(SFString newValue)

Add singleton SFString value to MFString parameter field.

Anchor

addUrl(String newValue)

Add singleton String value to MFString url field.

Anchor

addUrl(SFString newValue)

Add singleton SFString value to MFString url field.

Anchor

clearChildren()

Utility method to clear MFNode value of children field.

Anchor

clearIS()

Utility method to clear SFNode value of IS field.

Anchor

clearMetadata()

Utility method to clear SFNode value of metadata field.

Anchor

clearParameter()

Utility method to clear MFString value of parameter field.

Anchor

clearUrl()

Utility method to clear MFString value of url field.

X3DConcreteElement

findElementByNameValue(String nameValue)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.

X3DConcreteElement

findElementByNameValue(String nameValue, String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.

X3DConcreteNode

findNodeByDEF(String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

String

getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

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.

float[]

getBboxCenter()

Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.

boolean

getBboxDisplay()

Provide boolean value from inputOutput SFBool field named bboxDisplay.

float[]

getBboxSize()

Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.

X3DNode[]

getChildren()

Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.

ArrayList<X3DNode>

getChildrenList()

Utility method to get ArrayList value of MFNode children field, similar to getChildren().

final String

getComponent()

Defines X3D component for the Anchor element: Networking

final int

getComponentLevel()

Provides default X3D component level for this element: 2

final String

getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent.

String

getCssClass()

Provide String value from inputOutput SFString field named class.

String

getCssStyle()

Provide String value from inputOutput SFString field named style.

String

getDEF()

Provide String value from inputOutput SFString field named DEF.

String

getDescription()

Provide String value from inputOutput SFString field named description.

final String

getElementName()

Provides name of this element: Anchor

String

getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

String

getHtmlID()

Provide String value from inputOutput SFString field named id.

IS

getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

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[]

getParameter()

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

ArrayList<String>

getParameterList()

Utility method to get ArrayList value of MFString parameter field, similar to getParameter().

String

getParameterString()

Utility method to get String value of MFString parameter field, similar to getParameter().

String[]

getUrl()

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

ArrayList<String>

getUrlList()

Utility method to get ArrayList value of MFString url field, similar to getUrl().

String

getUrlString()

Utility method to get String value of MFString url field, similar to getUrl().

String

getUSE()

Provide String value from inputOutput SFString field named USE.

boolean

getVisible()

Provide boolean value from inputOutput SFBool field named visible.

boolean

hasChildren()

Indicate whether an object is available for inputOutput MFNode field children.

boolean

hasElementByNameValue(String nameValue, String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

boolean

hasIS()

Indicate whether an object is available for inputOutput SFNode field IS.

boolean

hasMetadata()

Indicate whether an object is available for inputOutput SFNode field metadata.

boolean

hasNodeByDEF(String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

final void

initialize()

Initialize all member variables to default values.

Anchor

setAutoRefresh(double newValue)

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

Anchor

setAutoRefresh(SFTime newValue)

Assign typed object value to SFTime autoRefresh field, similar to setAutoRefresh(double).

Anchor

setAutoRefreshTimeLimit(double newValue)

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

Anchor

setAutoRefreshTimeLimit(SFTime newValue)

Assign typed object value to SFTime autoRefreshTimeLimit field, similar to setAutoRefreshTimeLimit(double).

Anchor

setBboxCenter(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).

Anchor

setBboxCenter(double x, double y, double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).

Anchor

setBboxCenter(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

Anchor

setBboxCenter(float x, float y, float z)

Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).

Anchor

setBboxCenter(SFVec3f newValue)

Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).

Anchor

setBboxDisplay(boolean newValue)

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

Anchor

setBboxDisplay(SFBool newValue)

Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).

Anchor

setBboxSize(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).

Anchor

setBboxSize(double x, double y, double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).

Anchor

setBboxSize(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

Anchor

setBboxSize(float x, float y, float z)

Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).

Anchor

setBboxSize(SFVec3f newValue)

Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).

Anchor

setChildren(ArrayList<X3DChildNode> newValue)

Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).

void

setChildren(X3DNode newValue)

Set single children node, replacing prior array of existing nodes (if any).

Anchor

setChildren(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

final Anchor

setCssClass(String newValue)

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

Anchor

setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

final Anchor

setCssStyle(String newValue)

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

Anchor

setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

final Anchor

setDEF(String newValue)

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

Anchor

setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Anchor

setDescription(String newValue)

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

Anchor

setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

final Anchor

setHtmlID(String newValue)

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

Anchor

setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Anchor

setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Anchor

setLoad(boolean newValue)

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

Anchor

setLoad(SFBool newValue)

Assign typed object value to SFBool load field, similar to setLoad(boolean).

Anchor

setMetadata(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.

Anchor

setMetadata(X3DMetadataObject newValue)

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

Anchor

setParameter(String newValue)

Assign singleton String value to MFString parameter field, similar to setParameter(String[]).

Anchor

setParameter(String[] newValue)

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

Anchor

setParameter(ArrayList<String> newValue)

Assign ArrayList value of MFString parameter field, similar to setParameter(String[]).

Anchor

setParameter(MFString newValue)

Assign typed object value to MFString parameter field, similar to setParameter(String[]).

Anchor

setParameter(SFString newValue)

Assign single SFString object value to MFString parameter field, similar to setParameter(String[]).

Anchor

setUrl(String newValue)

Assign singleton String value to MFString url field, similar to setUrl(String[]).

Anchor

setUrl(String[] newValue)

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

Anchor

setUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString url field, similar to setUrl(String[]).

Anchor

setUrl(MFString newValue)

Assign typed object value to MFString url field, similar to setUrl(String[]).

Anchor

setUrl(SFString newValue)

Assign single SFString object value to MFString url field, similar to setUrl(String[]).

final Anchor

setUSE(String newValue)

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

Anchor

setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Anchor

setUSE(Anchor DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Anchor

setVisible(boolean newValue)

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

Anchor

setVisible(SFBool newValue)

Assign typed object value to SFBool visible field, similar to setVisible(boolean).

String

toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

String

toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

String

toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

String

validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- NAME
  public static final String NAME
  
  String constant NAME provides name of this element: Anchor.
  
  See Also:
  
  Constant Field Values
- COMPONENT
  public static final String COMPONENT
  
  String constant COMPONENT defines X3D component for the Anchor element: Networking
  
  See Also:
  
  Constant Field Values
- LEVEL
  public static final int LEVEL
  
  Integer constant LEVEL provides default X3D Networking component level for this element: 2
  
  See Also:
  
  Constant Field Values
- AUTOREFRESH_DEFAULT_VALUE
  public static final double AUTOREFRESH_DEFAULT_VALUE
  
  SFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).
  
  See Also:
  
  Constant Field Values
- AUTOREFRESHTIMELIMIT_DEFAULT_VALUE
  public static final double AUTOREFRESHTIMELIMIT_DEFAULT_VALUE
  
  SFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).
  
  See Also:
  
  Constant Field Values
- BBOXCENTER_DEFAULT_VALUE
  
  public static final float[] BBOXCENTER_DEFAULT_VALUE
  
  SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
- BBOXDISPLAY_DEFAULT_VALUE
  public static final boolean BBOXDISPLAY_DEFAULT_VALUE
  
  SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).
  
  See Also:
  
  Constant Field Values
- BBOXSIZE_DEFAULT_VALUE
  
  public static final float[] BBOXSIZE_DEFAULT_VALUE
  
  SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
- DESCRIPTION_DEFAULT_VALUE
  public static final String DESCRIPTION_DEFAULT_VALUE
  
  SFString field named description has default value equal to an empty string.
  
  See Also:
  
  Constant Field Values
- IS_DEFAULT_VALUE
  
  public static final IS IS_DEFAULT_VALUE
  
  SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
- LOAD_DEFAULT_VALUE
  public static final boolean LOAD_DEFAULT_VALUE
  
  SFBool field named load has default value true (Java syntax) or true (XML syntax).
  
  See Also:
  
  Constant Field Values
- METADATA_DEFAULT_VALUE
  
  public static final X3DMetadataObject METADATA_DEFAULT_VALUE
  
  SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
- PARAMETER_DEFAULT_VALUE
  
  public static final ArrayList<String> PARAMETER_DEFAULT_VALUE
  
  MFString field named parameter has default value equal to an empty list.
- URL_DEFAULT_VALUE
  
  public static final ArrayList<String> URL_DEFAULT_VALUE
  
  MFString field named url has default value equal to an empty list.
- VISIBLE_DEFAULT_VALUE
  public static final boolean VISIBLE_DEFAULT_VALUE
  
  SFBool field named visible has default value true (Java syntax) or true (XML syntax).
  
  See Also:
  
  Constant Field Values
- containerField_DEFAULT_VALUE
  public static final String containerField_DEFAULT_VALUE
  
  containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
  containerField_DEFAULT_VALUE = "children";
  containerField_ALLOWED_VALUES = {"children", "proxy" *Collision parent*, "children" }; type X3DUOM containerFieldChoicesX3DUrlObject
  
  See Also:
  
  X3D Scene Authoring Hints: containerField
  
  X3D Scene Authoring Hints: validation choices for containerField
  
  X3D Unified Object Model (X3DUOM)
  
  Constant Field Values
- toField_ADDCHILDREN
  public static final String toField_ADDCHILDREN
  
  toField ROUTE name for MFNode field named addChildren.
  
  See Also:
  
  Constant Field Values
- fromField_AUTOREFRESH
  public static final String fromField_AUTOREFRESH
  
  fromField ROUTE name for SFTime field named autoRefresh.
  
  See Also:
  
  Constant Field Values
- toField_AUTOREFRESH
  public static final String toField_AUTOREFRESH
  
  toField ROUTE name for SFTime field named autoRefresh.
  
  See Also:
  
  Constant Field Values
- fromField_AUTOREFRESHTIMELIMIT
  public static final String fromField_AUTOREFRESHTIMELIMIT
  
  fromField ROUTE name for SFTime field named autoRefreshTimeLimit.
  
  See Also:
  
  Constant Field Values
- toField_AUTOREFRESHTIMELIMIT
  public static final String toField_AUTOREFRESHTIMELIMIT
  
  toField ROUTE name for SFTime field named autoRefreshTimeLimit.
  
  See Also:
  
  Constant Field Values
- fromField_BBOXDISPLAY
  public static final String fromField_BBOXDISPLAY
  
  fromField ROUTE name for SFBool field named bboxDisplay.
  
  See Also:
  
  Constant Field Values
- toField_BBOXDISPLAY
  public static final String toField_BBOXDISPLAY
  
  toField ROUTE name for SFBool field named bboxDisplay.
  
  See Also:
  
  Constant Field Values
- fromField_CHILDREN
  public static final String fromField_CHILDREN
  
  fromField ROUTE name for MFNode field named children.
  
  See Also:
  
  Constant Field Values
- toField_CHILDREN
  public static final String toField_CHILDREN
  
  toField ROUTE name for MFNode field named children.
  
  See Also:
  
  Constant Field Values
- fromField_DESCRIPTION
  public static final String fromField_DESCRIPTION
  
  fromField ROUTE name for SFString field named description.
  
  See Also:
  
  Constant Field Values
- toField_DESCRIPTION
  public static final String toField_DESCRIPTION
  
  toField ROUTE name for SFString field named description.
  
  See Also:
  
  Constant Field Values
- fromField_IS
  public static final String fromField_IS
  
  fromField ROUTE name for SFNode field named IS.
  
  See Also:
  
  Constant Field Values
- fromField_LOAD
  public static final String fromField_LOAD
  
  fromField ROUTE name for SFBool field named load.
  
  See Also:
  
  Constant Field Values
- toField_LOAD
  public static final String toField_LOAD
  
  toField ROUTE name for SFBool field named load.
  
  See Also:
  
  Constant Field Values
- fromField_METADATA
  public static final String fromField_METADATA
  
  fromField ROUTE name for SFNode field named metadata.
  
  See Also:
  
  Constant Field Values
- toField_METADATA
  public static final String toField_METADATA
  
  toField ROUTE name for SFNode field named metadata.
  
  See Also:
  
  Constant Field Values
- fromField_PARAMETER
  public static final String fromField_PARAMETER
  
  fromField ROUTE name for MFString field named parameter.
  
  See Also:
  
  Constant Field Values
- toField_PARAMETER
  public static final String toField_PARAMETER
  
  toField ROUTE name for MFString field named parameter.
  
  See Also:
  
  Constant Field Values
- toField_REMOVECHILDREN
  public static final String toField_REMOVECHILDREN
  
  toField ROUTE name for MFNode field named removeChildren.
  
  See Also:
  
  Constant Field Values
- fromField_URL
  public static final String fromField_URL
  
  fromField ROUTE name for MFString field named url.
  
  See Also:
  
  Constant Field Values
- toField_URL
  public static final String toField_URL
  
  toField ROUTE name for MFString field named url.
  
  See Also:
  
  Constant Field Values
- fromField_VISIBLE
  public static final String fromField_VISIBLE
  
  fromField ROUTE name for SFBool field named visible.
  
  See Also:
  
  Constant Field Values
- toField_VISIBLE
  public static final String toField_VISIBLE
  
  toField ROUTE name for SFBool field named visible.
  
  See Also:
  
  Constant Field Values
Constructor Details
- Anchor
  
  public Anchor()
  
  Constructor for Anchor to initialize member variables with default values.
- Anchor
  
  public Anchor(String DEFlabel)
  
  Utility constructor that assigns DEF label after initializing member variables with default values.
  
  Parameters:
  
  DEFlabel - unique DEF name for this X3D node
Method Details
- getElementName
  
  public final String getElementName()
  
  Provides name of this element: Anchor
  
  Specified by:
  
  getElementName in class X3DConcreteElement
  
  Returns:
  
  name of this element
- getComponent
  
  public final String getComponent()
  
  Defines X3D component for the Anchor element: Networking
  
  Specified by:
  
  getComponent in class X3DConcreteElement
  
  Returns:
  
  X3D component for this element
- getComponentLevel
  
  public final int getComponentLevel()
  
  Provides default X3D component level for this element: 2
  
  Specified by:
  
  getComponentLevel in class X3DConcreteElement
  
  Returns:
  
  default X3D component level for this element
- getFieldType
  public String getFieldType(String fieldName)
  
  Indicate type corresponding to given fieldName.
  
  Specified by:
  
  getFieldType in class X3DConcreteElement
  
  Parameters:
  
  fieldName - name of field in this X3D node
  
  Returns:
  
  X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
  
  See Also:
  
  ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
- getAccessType
  public String getAccessType(String fieldName)
  
  Indicate accessType corresponding to given fieldName.
  
  Specified by:
  
  getAccessType in class X3DConcreteElement
  
  Parameters:
  
  fieldName - name of field in this X3D node
  
  Returns:
  
  X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
  
  See Also:
  
  ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
- getContainerFieldDefault
  public final String getContainerFieldDefault()
  
  containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.
  
  Specified by:
  
  getContainerFieldDefault in class X3DConcreteNode
  
  Returns:
  
  default containerField value
  
  See Also:
  
  containerField_DEFAULT_VALUE
  
  X3DConcreteNode.containerField_ALLOWED_VALUES
  
  X3D Scene Authoring Hints: containerField
  
  X3D Scene Authoring Hints: validation choices for containerField
  
  X3D Unified Object Model (X3DUOM)
- initialize
  
  public final void initialize()
  
  Initialize all member variables to default values.
  
  Overrides:
  
  initialize in class X3DConcreteNode
- getAutoRefresh
  
  public 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 Anchor
  
  Specified by:
  
  getAutoRefresh in interface X3DUrlObject
  
  Returns:
  
  value of autoRefresh field
- setAutoRefresh
  
  public Anchor 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 Anchor
  
  Specified by:
  
  setAutoRefresh in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the autoRefresh field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setAutoRefresh
  
  public Anchor setAutoRefresh(SFTime newValue)
  
  Assign typed object value to SFTime autoRefresh field, similar to setAutoRefresh(double).
  
  Parameters:
  
  newValue - is new value for the autoRefresh field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getAutoRefreshTimeLimit
  
  public 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 Anchor
  
  Specified by:
  
  getAutoRefreshTimeLimit in interface X3DUrlObject
  
  Returns:
  
  value of autoRefreshTimeLimit field
- setAutoRefreshTimeLimit
  
  public Anchor 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 Anchor
  
  Specified by:
  
  setAutoRefreshTimeLimit in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the autoRefreshTimeLimit field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setAutoRefreshTimeLimit
  
  public Anchor setAutoRefreshTimeLimit(SFTime newValue)
  
  Assign typed object value to SFTime autoRefreshTimeLimit field, similar to setAutoRefreshTimeLimit(double).
  
  Parameters:
  
  newValue - is new value for the autoRefreshTimeLimit field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBboxCenter
  public float[] getBboxCenter()
  
  Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
  
  Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
  
  Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
  
  Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  getBboxCenter in interface Anchor
  
  Specified by:
  
  getBboxCenter in interface X3DBoundedObject
  
  Specified by:
  
  getBboxCenter in interface X3DGroupingNode
  
  Returns:
  
  value of bboxCenter field
- setBboxCenter
  public Anchor setBboxCenter(float[] newValue)
  
  Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
  
  Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
  
  Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
  
  Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  setBboxCenter in interface Anchor
  
  Specified by:
  
  setBboxCenter in interface X3DBoundedObject
  
  Specified by:
  
  setBboxCenter in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the bboxCenter field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setBboxCenter
  
  public Anchor setBboxCenter(SFVec3f newValue)
  
  Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
  
  Parameters:
  
  newValue - is new value for the bboxCenter field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setBboxCenter
  
  public Anchor setBboxCenter(float x, float y, float z)
  
  Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  z - third component
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setBboxCenter
  
  public Anchor setBboxCenter(double x, double y, double z)
  
  Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  z - third component
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setBboxCenter
  
  public Anchor setBboxCenter(double[] newArray)
  
  Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
  
  Parameters:
  
  newArray - is new value for field
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBboxDisplay
  public boolean getBboxDisplay()
  
  Provide boolean value from inputOutput SFBool field named bboxDisplay.
  
  Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
  
  Hint: the bounding box is displayed regardless of whether contained content is visible.
  
  Specified by:
  
  getBboxDisplay in interface Anchor
  
  Specified by:
  
  getBboxDisplay in interface X3DBoundedObject
  
  Specified by:
  
  getBboxDisplay in interface X3DGroupingNode
  
  Returns:
  
  value of bboxDisplay field
- setBboxDisplay
  public Anchor setBboxDisplay(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
  
  Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
  
  Hint: the bounding box is displayed regardless of whether contained content is visible.
  
  Specified by:
  
  setBboxDisplay in interface Anchor
  
  Specified by:
  
  setBboxDisplay in interface X3DBoundedObject
  
  Specified by:
  
  setBboxDisplay in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the bboxDisplay field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setBboxDisplay
  
  public Anchor setBboxDisplay(SFBool newValue)
  
  Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).
  
  Parameters:
  
  newValue - is new value for the bboxDisplay field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBboxSize
  public float[] getBboxSize()
  
  Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
  
  Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
  
  Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
  
  Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
  
  Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  getBboxSize in interface Anchor
  
  Specified by:
  
  getBboxSize in interface X3DBoundedObject
  
  Specified by:
  
  getBboxSize in interface X3DGroupingNode
  
  Returns:
  
  value of bboxSize field
- setBboxSize
  public Anchor setBboxSize(float[] newValue)
  
  Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
  
  Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
  
  Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
  
  Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
  
  Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  setBboxSize in interface Anchor
  
  Specified by:
  
  setBboxSize in interface X3DBoundedObject
  
  Specified by:
  
  setBboxSize in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the bboxSize field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setBboxSize
  
  public Anchor setBboxSize(SFVec3f newValue)
  
  Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
  
  Parameters:
  
  newValue - is new value for the bboxSize field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setBboxSize
  
  public Anchor setBboxSize(float x, float y, float z)
  
  Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  z - third component
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setBboxSize
  
  public Anchor setBboxSize(double x, double y, double z)
  
  Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  z - third component
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setBboxSize
  
  public Anchor setBboxSize(double[] newArray)
  
  Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
  
  Parameters:
  
  newArray - is new value for field
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getChildren
  public X3DNode[] getChildren()
  
  Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.
  
  Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
  
  Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
  
  Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
  
  Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
  
  Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#GroupingAndChildrenNodes
  
  Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
  
  Specified by:
  
  getChildren in interface Anchor
  
  Specified by:
  
  getChildren in interface X3DGroupingNode
  
  Returns:
  
  value of children field
  
  See Also:
  
  X3DChildNode
- getChildrenList
  
  public ArrayList<X3DNode> getChildrenList()
  
  Utility method to get ArrayList value of MFNode children field, similar to getChildren().
  
  Returns:
  
  value of children field
- setChildren
  public Anchor setChildren(X3DNode[] newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
  
  Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
  
  Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
  
  Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
  
  Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
  
  Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#GroupingAndChildrenNodes
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
  
  Specified by:
  
  setChildren in interface Anchor
  
  Specified by:
  
  setChildren in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the children field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setChildren
  
  public Anchor setChildren(ArrayList<X3DChildNode> newValue)
  
  Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).
  
  Parameters:
  
  newValue - is new value for the children field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addChildren
  
  public void addChildren(X3DNode newValue)
  
  Add single node to existing array of children nodes (if any).
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode and ProtoInstance.
  
  Parameters:
  
  newValue - is new value to be appended the children field.
- addChildren
  
  public Anchor addChildren(ProtoInstance newValue)
  
  Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
  
  Parameters:
  
  newValue - is new value to be appended the parts field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addChild
  
  public Anchor addChild(X3DChildNode newValue)
  
  Utility method to add single child element to contained list of existing children nodes (if any).
  
  Parameters:
  
  newValue - is new node value to be appended the children field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addChildren
  
  public void addChildren(X3DNode[] newValue)
  
  Add array of children nodes to array of existing nodes (if any).
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
  
  Specified by:
  
  addChildren in interface Anchor
  
  Specified by:
  
  addChildren in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value array to be appended the children field.
- setChildren
  
  public void setChildren(X3DNode newValue)
  
  Set single children node, replacing prior array of existing nodes (if any).
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DChildNode.
  
  Specified by:
  
  setChildren in interface Anchor
  
  Specified by:
  
  setChildren in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new node for the children field (restricted to X3DChildNode)
- clearChildren
  
  public Anchor clearChildren()
  
  Utility method to clear MFNode value of children field. This method does not initialize withCHILDREN_DEFAULT_VALUE.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- hasChildren
  public boolean hasChildren()
  
  Indicate whether an object is available for inputOutput MFNode field children.
  
  Returns:
  
  whether a properly typed node or ProtoInstance array or CommentsBlock is available.
  
  See Also:
  
  getChildren()
- addComments
  
  public Anchor addComments(String newComment)
  
  Add comment as CommentsBlock to children field
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newComment - initial value
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addComments
  
  public Anchor addComments(String[] newComments)
  
  Add comments as String[] array to children field
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newComments - array of comments
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addComments
  
  public Anchor addComments(CommentsBlock newCommentsBlock)
  
  Add CommentsBlock to children field
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newCommentsBlock - block of comments to add
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDescription
  public 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 Anchor
  
  Specified by:
  
  getDescription in interface X3DUrlObject
  
  Returns:
  
  value of description field
- setDescription
  public Anchor 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 Anchor
  
  Specified by:
  
  setDescription in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setDescription
  
  public Anchor setDescription(SFString newValue)
  
  Assign typed object value to SFString description field, similar to setDescription(String).
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getIS
  public IS getIS()
  
  Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
  
  Specified by:
  
  getIS in class X3DConcreteNode
  
  Returns:
  
  value of IS field
  
  See Also:
  
  X3D Tooltips: IS
  
  X3D Tooltips: connect
- setIS
  public Anchor setIS(IS newValue)
  
  Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
  
  Specified by:
  
  setIS in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the IS field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Tooltips: IS
  
  X3D Tooltips: connect
- clearIS
  
  public Anchor clearIS()
  
  Utility method to clear SFNode value of IS field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- hasIS
  public boolean hasIS()
  
  Indicate whether an object is available for inputOutput SFNode field IS.
  
  Returns:
  
  whether a concrete statement or CommentsBlock is available.
  
  See Also:
  
  getIS()
- getLoad
  
  public 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 Anchor
  
  Specified by:
  
  getLoad in interface X3DUrlObject
  
  Returns:
  
  value of load field
- setLoad
  
  public Anchor 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 Anchor
  
  Specified by:
  
  setLoad in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the load field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setLoad
  
  public Anchor setLoad(SFBool newValue)
  
  Assign typed object value to SFBool load field, similar to setLoad(boolean).
  
  Parameters:
  
  newValue - is new value for the load field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getMetadata
  public X3DMetadataObject getMetadata()
  
  Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Specified by:
  
  getMetadata in interface Anchor
  
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DGroupingNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  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
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  public Anchor setMetadata(X3DMetadataObject newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Specified by:
  
  setMetadata in interface Anchor
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DGroupingNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  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
  
  X3D Scene Authoring Hints: Metadata Nodes
- clearMetadata
  
  public Anchor clearMetadata()
  
  Utility method to clear SFNode value of metadata field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- setMetadata
  public Anchor setMetadata(ProtoInstance newValue)
  
  Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Specified by:
  
  setMetadata in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  setMetadata(org.web3d.x3d.sai.Core.X3DMetadataObject)
- hasMetadata
  public boolean hasMetadata()
  
  Indicate whether an object is available for inputOutput SFNode field metadata.
  
  Returns:
  
  whether a properly typed node or ProtoInstance or CommentsBlock is available.
  
  See Also:
  
  getMetadata()
  
  getMetadataProtoInstance()
  
  X3D Scene Authoring Hints: Metadata Nodes
- getParameter
  public String[] getParameter()
  
  Provide array of String results from inputOutput MFString field named parameter.
  
  Tooltip: If provided, parameter tells the X3D player where to to redirect the loaded url.
  
  Hint: set parameter value as target=_blank to load the target url into a new browser frame.
  
  Hint: set parameter value as target=frame_name to load target url into another browser frame.
  
  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." Interchange profile
  
  Hint: this field may be ignored, applying the default value regardless.
  
  Specified by:
  
  getParameter in interface Anchor
  
  Returns:
  
  value of parameter field
- getParameterList
  
  public ArrayList<String> getParameterList()
  
  Utility method to get ArrayList value of MFString parameter field, similar to getParameter().
  
  Returns:
  
  value of parameter field
- getParameterString
  
  public String getParameterString()
  
  Utility method to get String value of MFString parameter field, similar to getParameter().
  
  Returns:
  
  value of parameter field
- setParameter
  public Anchor setParameter(String[] newValue)
  
  Accessor method to assign String array to inputOutput MFString field named parameter.
  
  Tooltip: If provided, parameter tells the X3D player where to to redirect the loaded url.
  
  Hint: set parameter value as target=_blank to load the target url into a new browser frame.
  
  Hint: set parameter value as target=frame_name to load target url into another browser frame.
  
  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." Interchange profile
  
  Hint: this field may be ignored, applying the default value regardless.
  
  Specified by:
  
  setParameter in interface Anchor
  
  Parameters:
  
  newValue - is new value for the parameter field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setParameter
  
  public Anchor setParameter(MFString newValue)
  
  Assign typed object value to MFString parameter field, similar to setParameter(String[]).
  
  Parameters:
  
  newValue - is new value for the parameter field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setParameter
  
  public Anchor setParameter(SFString newValue)
  
  Assign single SFString object value to MFString parameter field, similar to setParameter(String[]).
  
  Parameters:
  
  newValue - is new value for the parameter field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setParameter
  
  public Anchor setParameter(String newValue)
  
  Assign singleton String value to MFString parameter field, similar to setParameter(String[]).
  
  Parameters:
  
  newValue - is new value for the parameter field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setParameter
  
  public Anchor setParameter(ArrayList<String> newValue)
  
  Assign ArrayList value of MFString parameter field, similar to setParameter(String[]).
  
  Parameters:
  
  newValue - is new value for the parameter field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- clearParameter
  
  public Anchor clearParameter()
  
  Utility method to clear MFString value of parameter field. This method does not initialize withPARAMETER_DEFAULT_VALUE.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addParameter
  public Anchor addParameter(String newValue)
  
  Add singleton String value to MFString parameter field.
  
  Parameters:
  
  newValue - is new value to add to the parameter field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  MFString.cleanupEnumerationValues(String)
- addParameter
  public Anchor addParameter(SFString newValue)
  
  Add singleton SFString value to MFString parameter field.
  
  Parameters:
  
  newValue - is new value to add to the parameter field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  MFString.cleanupEnumerationValues(String)
- getUrl
  public 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 Anchor
  
  Specified by:
  
  getUrl in interface X3DUrlObject
  
  Returns:
  
  value of url field
- getUrlList
  
  public ArrayList<String> getUrlList()
  
  Utility method to get ArrayList value of MFString url field, similar to getUrl().
  
  Returns:
  
  value of url field
- getUrlString
  
  public String getUrlString()
  
  Utility method to get String value of MFString url field, similar to getUrl().
  
  Returns:
  
  value of url field
- setUrl
  public Anchor 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 Anchor
  
  Specified by:
  
  setUrl in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the url field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUrl
  
  public Anchor setUrl(MFString newValue)
  
  Assign typed object value to MFString url field, similar to setUrl(String[]).
  
  Parameters:
  
  newValue - is new value for the url field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUrl
  
  public Anchor setUrl(SFString newValue)
  
  Assign single SFString object value to MFString url field, similar to setUrl(String[]).
  
  Parameters:
  
  newValue - is new value for the url field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUrl
  
  public Anchor setUrl(String newValue)
  
  Assign singleton String value to MFString url field, similar to setUrl(String[]).
  
  Parameters:
  
  newValue - is new value for the url field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUrl
  
  public Anchor setUrl(ArrayList<String> newValue)
  
  Assign ArrayList value of MFString url field, similar to setUrl(String[]).
  
  Parameters:
  
  newValue - is new value for the url field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- clearUrl
  
  public Anchor clearUrl()
  
  Utility method to clear MFString value of url field. This method does not initialize withURL_DEFAULT_VALUE.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addUrl
  public Anchor addUrl(String newValue)
  
  Add singleton String value to MFString url field.
  
  Parameters:
  
  newValue - is new value to add to the url field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  MFString.cleanupEnumerationValues(String)
- addUrl
  public Anchor addUrl(SFString newValue)
  
  Add singleton SFString value to MFString url field.
  
  Parameters:
  
  newValue - is new value to add to the url field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  MFString.cleanupEnumerationValues(String)
- getVisible
  public boolean getVisible()
  
  Provide boolean value from inputOutput SFBool field named visible.
  
  Tooltip: Whether or not renderable content within this node is visually displayed.
  
  Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
  
  Hint: content must be visible to be collidable and to be pickable.
  
  Specified by:
  
  getVisible in interface Anchor
  
  Specified by:
  
  getVisible in interface X3DBoundedObject
  
  Specified by:
  
  getVisible in interface X3DGroupingNode
  
  Returns:
  
  value of visible field
- setVisible
  public Anchor setVisible(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named visible.
  
  Tooltip: Whether or not renderable content within this node is visually displayed.
  
  Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
  
  Hint: content must be visible to be collidable and to be pickable.
  
  Specified by:
  
  setVisible in interface Anchor
  
  Specified by:
  
  setVisible in interface X3DBoundedObject
  
  Specified by:
  
  setVisible in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the visible field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setVisible
  
  public Anchor setVisible(SFBool newValue)
  
  Assign typed object value to SFBool visible field, similar to setVisible(boolean).
  
  Parameters:
  
  newValue - is new value for the visible field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDEF
  public String getDEF()
  
  Provide String value from inputOutput SFString field named DEF.
  
  Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
  
  Hint: descriptive DEF names improve clarity and help document a model.
  
  Hint: well-defined names can simplify design and debugging through improved author understanding.
  
  Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
  
  Overrides:
  
  getDEF in class X3DConcreteNode
  
  Returns:
  
  value of DEF field
  
  See Also:
  
  X3D Scene Authoring Hints: Naming Conventions
- setDEF
  public final Anchor setDEF(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named DEF.
  
  Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
  
  Hint: descriptive DEF names improve clarity and help document a model.
  
  Hint: well-defined names can simplify design and debugging through improved author understanding.
  
  Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
  
  Note that setting the DEF value clears the USE value.
  
  Specified by:
  
  setDEF in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the DEF field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setDEF
  
  public Anchor setDEF(SFString newValue)
  
  Assign typed object value to SFString DEF field, similar to setDEF(String).
  
  Parameters:
  
  newValue - is new value for the DEF field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getUSE
  public String getUSE()
  
  Provide String value from inputOutput SFString field named USE.
  
  Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
  
  Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
  
  Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
  
  Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
  
  Overrides:
  
  getUSE in class X3DConcreteNode
  
  Returns:
  
  value of USE field
  
  See Also:
  
  X3D Scene Authoring Hints: Naming Conventions
- setUSE
  public final Anchor setUSE(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named USE.
  
  Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
  
  Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
  
  Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
  
  Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
  
  Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
  
  Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
  
  Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
  
  Specified by:
  
  setUSE in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the USE field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUSE
  
  public Anchor setUSE(SFString newValue)
  
  Assign typed object value to SFString USE field, similar to setUSE(String).
  
  Parameters:
  
  newValue - is new value for the USE field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getCssClass
  public String getCssClass()
  
  Provide String value from inputOutput SFString field named class.
  
  Tooltip: The class attribute on each X3D node and statement is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
  
  Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
  
  Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/htmlGuidelines.html#CSS
  
  Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
  
  Hint: CSS Snapshot https://www.w3.org/TR/css-2018
  
  Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets
  
  Overrides:
  
  getCssClass in class X3DConcreteElement
  
  Returns:
  
  value of class field
  
  See Also:
  
  X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  
  W3C Cascading Style Sheets
  
  W3C CSS Snapshot
  
  Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
- setCssClass
  public final Anchor setCssClass(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named class.
  
  Tooltip: The class attribute on each X3D node and statement is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
  
  Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
  
  Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/htmlGuidelines.html#CSS
  
  Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
  
  Hint: CSS Snapshot https://www.w3.org/TR/css-2018
  
  Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets
  
  Specified by:
  
  setCssClass in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the class field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  
  W3C Cascading Style Sheets
  
  W3C CSS Snapshot
  
  Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
- setCssClass
  
  public Anchor setCssClass(SFString newValue)
  
  Assign typed object value to SFString cssClass field, similar to setCssClass(String).
  
  Parameters:
  
  newValue - is new value for the class field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getHtmlID
  public String getHtmlID()
  
  Provide String value from inputOutput SFString field named id.
  
  Tooltip: The id attribute on each X3D node and statement is considered a unique identifier when used as part of an encompassing HTML/DOM context.
  
  Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
  
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
  
  Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/htmlGuidelines.html#CSS
  
  Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id
  
  Overrides:
  
  getHtmlID in class X3DConcreteElement
  
  Returns:
  
  value of id field
  
  See Also:
  
  X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  
  W3C Cascading Style Sheets
  
  W3C CSS Snapshot
  
  Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
- setHtmlID
  public final Anchor setHtmlID(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named id.
  
  Tooltip: The id attribute on each X3D node and statement is considered a unique identifier when used as part of an encompassing HTML/DOM context.
  
  Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
  
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
  
  Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/htmlGuidelines.html#CSS
  
  Hint: HTML5 id attribute https://www.w3.org/TR/dom41/#dom-element-id
  
  Specified by:
  
  setHtmlID in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the id field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
  
  X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
  
  HTML 5.2 W3C Recommendation
  
  Document Object Model (DOM) Technical Reports
  
  Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
- setHtmlID
  
  public Anchor setHtmlID(SFString newValue)
  
  Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
  
  Parameters:
  
  newValue - is new value for the id field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getCssStyle
  public String getCssStyle()
  
  Provide String value from inputOutput SFString field named style.
  
  Tooltip: The style attribute on each X3D node and statement provides an inline block of CSS source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
  
  Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
  
  Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/htmlGuidelines.html#CSS
  
  Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
  
  Hint: CSS Snapshot https://www.w3.org/TR/css-2018
  
  Hint: https://www.w3.org/TR/css-style-attr
  
  Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets
  
  Overrides:
  
  getCssStyle in class X3DConcreteElement
  
  Returns:
  
  value of style field
  
  See Also:
  
  X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  
  W3C Cascading Style Sheets
  
  W3C CSS Snapshot
  
  Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
- setCssStyle
  public final Anchor setCssStyle(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named style.
  
  Tooltip: The style attribute on each X3D node and statement provides an inline block of CSS source for element styling, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
  
  Hint: this attribute is only functional if the X3D model is loaded within an HTML page.
  
  Hint: X3D Architecture Annex L, HTML authoring guidelines, CSS considerations https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/htmlGuidelines.html#CSS
  
  Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
  
  Hint: CSS Snapshot https://www.w3.org/TR/css-2018
  
  Hint: https://www.w3.org/TR/css-style-attr
  
  Hint: Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets https://en.wikibooks.org/wiki/XML_-_Managing_Data_Exchange/XSLT_and_Style_Sheets
  
  Specified by:
  
  setCssStyle in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the style field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  
  W3C Cascading Style Sheets
  
  W3C CSS Snapshot
  
  Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
- setCssStyle
  
  public Anchor setCssStyle(SFString newValue)
  
  Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
  
  Parameters:
  
  newValue - is new value for the style field.
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUSE
  
  public Anchor setUSE(Anchor DEFnode)
  
  Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
  
  Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
  
  Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
  
  Parameters:
  
  DEFnode - must have a DEF value defined
  
  Returns:
  
  Anchor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- toStringX3D
  public String toStringX3D(int indentLevel)
  
  Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
  
  Specified by:
  
  toStringX3D in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  X3D string
  
  See Also:
  
  X3D.FILE_EXTENSION_X3D
  
  X3D.FILE_EXTENSION_XML
  
  X3D.toStringXML()
  
  X3D.toFileXML(String)
  
  X3D.toFileX3D(String)
  
  X3D XML Encoding
  
  X3D Compressed Binary Encoding: X3D Canonical Form
  
  X3D Canonicalization (C14N) Tool
- toStringClassicVRML
  public String toStringClassicVRML(int indentLevel)
  
  Recursive method to provide ClassicVRML string serialization.
  
  Specified by:
  
  toStringClassicVRML in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  ClassicVRML string
  
  See Also:
  
  X3D.FILE_EXTENSION_CLASSICVRML
  
  X3D Resources: Virtual Reality Modeling Language (VRML) 97
  
  Extensible 3D (X3D) encodings Part 2: Classic VRML encoding
  
  Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
- toStringVRML97
  public String toStringVRML97(int indentLevel)
  
  Recursive method to provide VRML97 string serialization.
  
  Specified by:
  
  toStringVRML97 in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  VRML97 string
  
  See Also:
  
  X3D.FILE_EXTENSION_VRML97
  
  X3D Resources: Virtual Reality Modeling Language (VRML) 97
  
  Virtual Reality Modeling Language (VRML) 97 specification
  
  VRML 97 v2.1 Amendment
- findElementByNameValue
  public X3DConcreteElement findElementByNameValue(String nameValue)
  
  Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
  
  Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
  
  Warning: more than one element may be found that has the same name, this method does not handle that case.
  
  Specified by:
  
  findElementByNameValue in class X3DConcreteElement
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  object reference to found element, null otherwise
  
  See Also:
  
  findNodeByDEF(String)
  
  X3DConcreteElement.hasAncestorScene()
  
  X3DConcreteElement.findAncestorX3D()
- findElementByNameValue
  public X3DConcreteElement findElementByNameValue(String nameValue, String elementName)
  
  Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
  
  Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
  
  Warning: more than one element may be found that has the same name, this method does not handle that case.
  
  Specified by:
  
  findElementByNameValue in class X3DConcreteElement
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
  
  Returns:
  
  object reference to found element, null otherwise
  
  See Also:
  
  findNodeByDEF(String)
  
  X3DConcreteElement.hasAncestorScene()
  
  X3DConcreteElement.findAncestorX3D()
- hasElementByNameValue
  public boolean hasElementByNameValue(String nameValue, String elementName)
  
  Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
  
  Returns:
  
  whether node is found
  
  See Also:
  
  findElementByNameValue(String, String)
- findNodeByDEF
  public X3DConcreteNode findNodeByDEF(String DEFvalue)
  
  Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
  
  Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
  
  Warning: more than one element may be found that has the same DEF, this method does not handle that case.
  
  Specified by:
  
  findNodeByDEF in class X3DConcreteElement
  
  Parameters:
  
  DEFvalue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  object reference to found node, null otherwise
  
  See Also:
  
  findElementByNameValue(String)
  
  X3DConcreteElement.hasAncestorScene()
  
  X3DConcreteElement.findAncestorX3D()
- hasNodeByDEF
  public boolean hasNodeByDEF(String DEFvalue)
  
  Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
  
  Parameters:
  
  DEFvalue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  whether node is found
  
  See Also:
  
  findNodeByDEF(String)
- validate
  
  public String validate()
  
  Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.
  
  Specified by:
  
  validate in class X3DConcreteElement
  
  Returns:
  
  validation results (if any)

Class Anchor

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Details

NAME

COMPONENT

LEVEL

AUTOREFRESH_DEFAULT_VALUE

AUTOREFRESHTIMELIMIT_DEFAULT_VALUE

BBOXCENTER_DEFAULT_VALUE

BBOXDISPLAY_DEFAULT_VALUE

BBOXSIZE_DEFAULT_VALUE

DESCRIPTION_DEFAULT_VALUE

IS_DEFAULT_VALUE

LOAD_DEFAULT_VALUE

METADATA_DEFAULT_VALUE

PARAMETER_DEFAULT_VALUE

URL_DEFAULT_VALUE

VISIBLE_DEFAULT_VALUE

containerField_DEFAULT_VALUE

toField_ADDCHILDREN

fromField_AUTOREFRESH

toField_AUTOREFRESH

fromField_AUTOREFRESHTIMELIMIT

toField_AUTOREFRESHTIMELIMIT

fromField_BBOXDISPLAY

toField_BBOXDISPLAY

fromField_CHILDREN

toField_CHILDREN

fromField_DESCRIPTION

toField_DESCRIPTION

fromField_IS

fromField_LOAD

toField_LOAD

fromField_METADATA

toField_METADATA

fromField_PARAMETER

toField_PARAMETER

toField_REMOVECHILDREN

fromField_URL

toField_URL

fromField_VISIBLE

toField_VISIBLE

Constructor Details

Anchor

Anchor

Method Details

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getAutoRefresh

setAutoRefresh

setAutoRefresh

getAutoRefreshTimeLimit

setAutoRefreshTimeLimit

setAutoRefreshTimeLimit

getBboxCenter

setBboxCenter

setBboxCenter

setBboxCenter

setBboxCenter

setBboxCenter

getBboxDisplay

setBboxDisplay

setBboxDisplay

getBboxSize

setBboxSize

setBboxSize

setBboxSize

setBboxSize