Class Contour2D

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.NURBS.Contour2D

All Implemented Interfaces:

X3DNode, Contour2D

public class Contour2D
extends X3DConcreteNode
implements Contour2D

Contour2D groups a set of curve segments into a composite contour.

Contour2D node tooltip: [X3DNode] Contour2D groups a set of curve segments into a composite contour. The children segments form a closed loop, with first point of first child repeated as last point of last child, and last point of each segment repeated as the first point of the next consecutive segment. The children segments are type NurbsCurve2D or ContourPolyline2D, enumerated in the consecutive order of contour topology.

• Warning: Contour2D is not a renderable geometry node.
• Hint: Contour2D is used as the trimmingContour field of the NurbsTrimmedSurface node.

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:

• X3D Abstract Specification: Contour2D
• X3D Tooltips: Contour2D
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the Contour2D element: NURBS
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_CHILDREN	fromField ROUTE name for MFNode field named children.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
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 NURBS component level for this element: 4
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: Contour2D.
static final String	toField_ADDCHILDREN	toField ROUTE name for MFNode field named addChildren.
static final String	toField_CHILDREN	toField ROUTE name for MFNode field named children.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_REMOVECHILDREN	toField ROUTE name for MFNode field named removeChildren.

Fields inherited from class X3DConcreteNode

containerField_ALLOWED_VALUES, containerFieldOverride

Modifier and Type	Field	Description
String[]	containerField_ALLOWED_VALUES	This string array provides all allowed containerField values for this node, starting with the default value.
String	containerFieldOverride	Warning: containerFieldOverride describes a non-default field relationship of a node to its parent, overriding the default or alternate containerField value.

Fields inherited from class X3DConcreteElement

validationResult

Modifier and Type	Field	Description
protected StringBuilder	validationResult	Results log of local validation.

Constructor Summary

Constructors

Constructor	Description
Contour2D()	Constructor for Contour2D to initialize member variables with default values.
Contour2D(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
Contour2D	addChild(ContourPolyline2D newValue)	Add single children node to array of existing children nodes (if any) for Contour2D.
Contour2D	addChild(NurbsCurve2D newValue)	Add single children node to array of existing children nodes (if any) for Contour2D.
Contour2D	addChild(X3DChildNode newValue)	Utility method to add single child element to contained list of existing children nodes (if any).
Contour2D	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).
Contour2D	addComments(String newComment)	Append single comment as CommentsBlock to children field
Contour2D	addComments(String[] newComments)	Append comments as CommentsBlock to children field
Contour2D	addComments(CommentsBlock newCommentsBlock)	Append CommentsBlock to children field
Contour2D	clearChildren()	Utility method to clear MFNode value of children field.
Contour2D	clearComments()	Clear comments from children field
Contour2D	clearIS()	Utility method to clear SFNode value of IS field.
Contour2D	clearMetadata()	Utility method to clear SFNode value of metadata 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.
X3DNode[]	getChildren()	Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to NurbsCurve2D|ContourPolyline2D, from inputOutput MFNode field children.
ArrayList<X3DNode>	getChildrenList()	Utility method to get ArrayList value of MFNode children field, similar to getChildren().
ArrayList<CommentsBlock>	getCommentsBlockList()	Retrieve comments from children field as a list of CommentsBlock lists, without modifying children field
final String	getComponent()	Defines X3D component for the Contour2D element: NURBS
final int	getComponentLevel()	Provides default X3D component level for this element: 4
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.
final String	getElementName()	Provides name of this element: Contour2D
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.
static final IS	getISDefault()	Public accessor for encapsulated SFNode default value null, returned as IS.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
static final X3DMetadataObject	getMetadataDefault()	Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Core.X3DMetadataObject.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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.
Contour2D	setChildren(ArrayList<X3DNode> newValue)	Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).
void	setChildren(X3DNode newValue)	Utility method to set single children node, replacing prior array of existing nodes (if any).
Contour2D	setChildren(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
Contour2D	setComments(CommentsBlock newCommentsBlock)	Append single CommentsBlock list to children field, replacing other comments
final Contour2D	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
Contour2D	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final Contour2D	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
Contour2D	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final Contour2D	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
Contour2D	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
final Contour2D	setHtmlId(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
Contour2D	setHtmlId(SFString newValue)	Assign typed object value to SFString HtmlId field, similar to setHtmlId(String).
Contour2D	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
Contour2D	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
Contour2D	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
final Contour2D	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
Contour2D	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
Contour2D	setUSE(Contour2D DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
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 X3DConcreteNode

getContainerFieldAllowedValues, getContainerFieldOverride, getDEFDefault, getName, getUSEDefault, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Modifier and Type	Method	Description
String[]	getContainerFieldAllowedValues()	containerField describes the field relationship of a node to its parent.
String	getContainerFieldOverride()	Warning: containerFieldOverride describes a non-default field relationship of a node to its parent, overriding the default or alternate containerField value.
String	getDEFDefault()	Public SFString accessor for field named DEF has default value equal to an empty string.
String	getName()	Utility method to permit querying name value
String	getUSEDefault()	Public SFString accessor for field named USE has default value equal to an empty string.
boolean	hasDEF()	Utility method to indicate whether this element has a DEF identifier.
boolean	hasNameField()	Whether or not this class has a getName() method
boolean	hasUSE()	Utility method to indicate whether this element has a USE reference to another previously defined element (which means other fields must be empty).
protected void	includesNameField()	Protected method for X3DJSAIL class initialize() methods to indicate whether the current concrete node has a getName() method
static final boolean	isNode()	Utility method to indicate whether this element is an X3D Graphics node (implementing X3DConcreteNode), returns true.
static final boolean	isStatement()	Utility method to indicate whether this element is an X3D Graphics statement (implementing X3DConcreteStatement), returns false.
void	resetContainerFieldOverride()	Warning: containerFieldOverride describes a non-default field relationship of a node to its parent, overriding the default or alternate containerField value.
protected void	setConcreteDEF(String newValue)	Protected internal superclass method to keep DEF private, scene authors should use method setDEF(newValue) instead.
protected final void	setConcreteUSE(String newValue)	Protected internal superclass method to keep USE private, scene authors should use method setUse(newValue) instead.
X3DConcreteNode	setContainerFieldOverride(String value)	Warning: containerFieldOverride describes a non-default field relationship of a node to its parent, overriding the default or alternate containerField value.

Methods inherited from class X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getCssClassDefault, getCssStyleDefault, getHtmlIdDefault, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlId, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Modifier and Type	Method	Description
X3DConcreteElement	addComments()	Debug support: adding empty comment as CommentsBlock to children field has no effect.
void	clearParent()	Package-protected internal method to clear local reference to parent object, if any.
X3DConcreteElement	findAncestorElementByName(String ancestorElementName)	Find object reference to ancestor element (i.e. node or statement), if this object is an attached child.
ProtoBody	findAncestorProtoBody()	Find object reference to ancestor ProtoBody, if this node or statement is a child.
Scene	findAncestorScene()	Find object reference to ancestor Scene element, assumes this object is an attached child.
X3D	findAncestorX3D()	Find object reference to ancestor X3D element, if this node or statement is part of an X3D object.
static final String	getCssClassDefault()	Public SFString accessor for field named class for CSS has default value equal to an empty string.
static final String	getCssStyleDefault()	Public SFString accessor for field named style for CSS has default value equal to an empty string.
static final String	getHtmlIdDefault()	Public SFString accessor for field named id for html has default value equal to an empty string.
static String	getPackageName(String className)	Provide fully qualified package for a given element object, including className.
X3DConcreteElement	getParent()	Provide object reference to parent X3D node or statement, if any.
String	getValidationResult()	Get output of results from prior validation, if any
boolean	hasAncestorElementByName(String ancestorElementName)	Determine whether ancestor element (i.e. node or statement) is found, meaning this object is an attached child.
boolean	hasAncestorProtoBody()	Determine whether ancestor ProtoBody element is found, meaning this object is an attached child.
boolean	hasAncestorScene()	Determine whether ancestor Scene element is found, meaning this object is an attached child.
boolean	hasAncestorX3D()	Determine whether ancestor X3D element is found, meaning this object is an attached child.
boolean	hasParent()	Whether parent object exists.
boolean	isValid()	Recursive method to determine whether this element is valid.
protected void	setConcreteCssClass(String newValue)	Protected internal superclass method to keep cssClass private, scene authors should use method setCssClass(newValue) instead.
protected void	setConcreteCssStyle(String newValue)	Protected internal superclass method to keep cssStyles private, scene authors should use method setCssStyle(newValue) instead.
protected void	setConcreteHtmlId(String newValue)	Protected internal superclass method to keep HTML id private, scene authors should use method setHtmlId(newValue) instead.
void	setParent(X3DConcreteElement newParentObject)	Package-internal method to set parent object reference.
String	toStringClassicVRML()	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97()	Recursive method to provide VRML97 string serialization.
String	toStringX3D()	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Methods inherited from class 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: Contour2D.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the Contour2D element: NURBS

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D NURBS component level for this element: 4

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).

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

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 = "trimmingContour";
containerField_ALLOWED_VALUES = {"trimmingContour" }; type xs:NMTOKEN

See Also:

• X3DConcreteNode.containerField_ALLOWED_VALUES
• 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_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_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

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

toField_REMOVECHILDREN

public static final String toField_REMOVECHILDREN

toField ROUTE name for MFNode field named removeChildren.

See Also:

• Constant Field Values

Constructor Details

Contour2D

public Contour2D()

Constructor for Contour2D to initialize member variables with default values.

Contour2D

public Contour2D(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: Contour2D

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the Contour2D element: NURBS

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: 4

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getISDefault

public static final IS getISDefault()

Public accessor for encapsulated SFNode default value null, returned as IS.

Returns:

default value

getMetadataDefault

public static final X3DMetadataObject getMetadataDefault()

Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Core.X3DMetadataObject.

Returns:

default value

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

getChildren

public X3DNode[] getChildren()

Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to NurbsCurve2D|ContourPolyline2D, from inputOutput MFNode field children.

Tooltip: [NurbsCurve2D|ContourPolyline2D] The children form a closed loop with first point of first child repeated as last point of last child, and the last point of a segment repeated as first point of the consecutive one.

• Hint: children nodes are listed in consecutive order according to topology of the contour.

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to NurbsCurve2D|ContourPolyline2D.

Specified by:

getChildren in interface Contour2D

Returns:

value of children field

See Also:

• NurbsCurve2D
• ContourPolyline2D

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 Contour2D setChildren(X3DNode[] newValue)

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

Tooltip: [NurbsCurve2D|ContourPolyline2D] The children form a closed loop with first point of first child repeated as last point of last child, and the last point of a segment repeated as first point of the consecutive one.

• Hint: children nodes are listed in consecutive order according to topology of the contour.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to NurbsCurve2D|ContourPolyline2D.

Specified by:

setChildren in interface Contour2D

Parameters:

newValue - is new value for the children field.

Returns:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setChildren

public Contour2D setChildren(ArrayList<X3DNode> 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:

Contour2D - 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 NurbsCurve2D|ContourPolyline2D and ProtoInstance.

Parameters:

newValue - is new value to be appended the children field.

addChildren

public Contour2D 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:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addChild

public Contour2D 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:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addChild

public Contour2D addChild(NurbsCurve2D newValue)

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

Parameters:

newValue - is new node value to be appended the children field.

Returns:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addChild

public Contour2D addChild(ContourPolyline2D newValue)

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

Parameters:

newValue - is new node value to be appended the children field.

Returns:

Contour2D - 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 NurbsCurve2D|ContourPolyline2D.

Specified by:

addChildren in interface Contour2D

Parameters:

newValue - is new value array to be appended the children field.

setChildren

public void setChildren(X3DNode newValue)

Utility method to 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 NurbsCurve2D|ContourPolyline2D.

Specified by:

setChildren in interface Contour2D

Parameters:

newValue - is new node for the children field (restricted to NurbsCurve2D|ContourPolyline2D)

clearChildren

public Contour2D clearChildren()

Utility method to clear MFNode value of children field. This method does not initialize with CHILDREN_DEFAULT_VALUE.

Returns:

Contour2D - 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 Contour2D addComments(String newComment)

Append single comment as CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - single comment string

Returns:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public Contour2D addComments(String[] newComments)

Append comments as CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comment strings

Returns:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public Contour2D addComments(CommentsBlock newCommentsBlock)

Append CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearComments

public Contour2D clearComments()

Clear comments from children field

Returns:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCommentsBlockList

public ArrayList<CommentsBlock> getCommentsBlockList()

Retrieve comments from children field as a list of CommentsBlock lists, without modifying children field

Returns:

list of all available CommentsBlock entries in children field

setComments

public Contour2D setComments(CommentsBlock newCommentsBlock)

Append single CommentsBlock list to children field, replacing other comments

Parameters:

newCommentsBlock - block of comments to add

Returns:

invalid reference

HAnimJoint

- 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 Contour2D 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:

Contour2D - 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 Contour2D clearIS()

Utility method to clear SFNode value of IS field.

Returns:

Contour2D - 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()

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 Contour2D

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 Contour2D 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 Contour2D

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

Contour2D - 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 Contour2D clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public Contour2D 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:

Contour2D - 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

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 Contour2D 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:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public Contour2D 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:

Contour2D - 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 reference a separately 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 separately 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) within a USE node.
• Warning: each USE value must match a corresponding DEF value that is defined elsewhere in the scene.
• Hint: a USE node is no longer required to follow the corresponding DEF node being referenced.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final Contour2D setUSE(String newValue)

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

Tooltip: USE means reference a separately 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 separately 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) within a USE node.
• Warning: each USE value must match a corresponding DEF value that is defined elsewhere in the scene.
• Hint: a USE node is no longer required to follow the corresponding DEF node being referenced.

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:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public Contour2D 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:

Contour2D - 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.

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 tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final Contour2D setCssClass(String newValue)

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

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

Contour2D - 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 tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public Contour2D 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:

Contour2D - 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.

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 tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlId

public final Contour2D setHtmlId(String newValue)

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

Specified by:

setHtmlId in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

Contour2D - 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 Contour2D 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:

Contour2D - 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.

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 tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final Contour2D setCssStyle(String newValue)

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

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

Contour2D - 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 tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public Contour2D 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:

Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public Contour2D setUSE(Contour2D 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:

Contour2D - 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)