Package org.web3d.x3d.jsail.Shape

Class FillProperties

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Shape.FillProperties

All Implemented Interfaces:

X3DNode, FillProperties, X3DAppearanceChildNode

public class FillProperties
extends X3DConcreteNode
implements FillProperties

FillProperties indicates whether appearance is filled or hatched for associated geometry nodes inside the same Shape.

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. FillProperties node tooltip: [X3DAppearanceChildNode] FillProperties indicates whether appearance is filled or hatched for associated geometry nodes inside the same Shape. Hatches are applied on top of the already rendered appearance of the node, and are not affected by lighting.

• Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
• Warning: requires X3D profile='Full' or else include <component name='Shape' level='3'/>

Note that SFColor provides a variety of color constants.

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: FillProperties
• X3D Tooltips: FillProperties
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the FillProperties element: Shape
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final boolean	FILLED_DEFAULT_VALUE	SFBool field named filled has default value true (Java syntax) or true (XML syntax).
static final String	fromField_FILLED	fromField ROUTE name for SFBool field named filled.
static final String	fromField_HATCHCOLOR	fromField ROUTE name for SFColor field named hatchColor.
static final String	fromField_HATCHED	fromField ROUTE name for SFBool field named hatched.
static final String	fromField_HATCHSTYLE	fromField ROUTE name for SFInt32 field named hatchStyle.
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 float[]	HATCHCOLOR_DEFAULT_VALUE	SFColor field named hatchColor has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
static final boolean	HATCHED_DEFAULT_VALUE	SFBool field named hatched has default value true (Java syntax) or true (XML syntax).
static final String	HATCHSTYLE_1_ALIAS	SFString SFInt32 enumeration value "1" has alias "HORIZONTAL"
static final String	HATCHSTYLE_10_ALIAS	SFString SFInt32 enumeration value "10" has alias "WHITE_METAL_ZINC_LEAD_BABBIT_ALLOYS"
static final String	HATCHSTYLE_11_ALIAS	SFString SFInt32 enumeration value "11" has alias "MAGNESIUM_ALUMINUM_ALLOYS"
static final String	HATCHSTYLE_12_ALIAS	SFString SFInt32 enumeration value "12" has alias "RUBBER_PLASTIC_ELECTRICAL_INSULATION"
static final String	HATCHSTYLE_13_ALIAS	SFString SFInt32 enumeration value "13" has alias "CORK_FELT_FABRIC_LEATHER_FIBRE"
static final String	HATCHSTYLE_14_ALIAS	SFString SFInt32 enumeration value "14" has alias "THERMAL_INSULATION"
static final String	HATCHSTYLE_15_ALIAS	SFString SFInt32 enumeration value "15" has alias "TITANIUM"
static final String	HATCHSTYLE_16_ALIAS	SFString SFInt32 enumeration value "16" has alias "MARBLE_SLATE_PORCELAIN_GLASS"
static final String	HATCHSTYLE_17_ALIAS	SFString SFInt32 enumeration value "17" has alias "EARTH"
static final String	HATCHSTYLE_18_ALIAS	SFString SFInt32 enumeration value "18" has alias "SAND"
static final String	HATCHSTYLE_19_ALIAS	SFString SFInt32 enumeration value "19" has alias "REPEATING_DOT"
static final String	HATCHSTYLE_2_ALIAS	SFString SFInt32 enumeration value "2" has alias "VERTICAL"
static final String	HATCHSTYLE_3_ALIAS	SFString SFInt32 enumeration value "3" has alias "POSITIVE_SLOPE"
static final String	HATCHSTYLE_4_ALIAS	SFString SFInt32 enumeration value "4" has alias "NEGATIVE_SLOPE"
static final String	HATCHSTYLE_5_ALIAS	SFString SFInt32 enumeration value "5" has alias "HORIZONTAL_VERTICAL_CROSSHATCH"
static final String	HATCHSTYLE_6_ALIAS	SFString SFInt32 enumeration value "6" has alias "POSITIVE_NEGATIVE_SLOPE_CROSSHATCH"
static final String	HATCHSTYLE_7_ALIAS	SFString SFInt32 enumeration value "7" has alias "CAST_IRON"
static final String	HATCHSTYLE_8_ALIAS	SFString SFInt32 enumeration value "8" has alias "STEEL"
static final String	HATCHSTYLE_9_ALIAS	SFString SFInt32 enumeration value "9" has alias "BRONZE_BRASS_COPPER_COMPOSITIONS"
static final String	HATCHSTYLE_BRONZE_BRASS_COPPER_COMPOSITIONS	Tooltip: (bronze, brass, copper, and compositions).
static final String	HATCHSTYLE_CAST_IRON	Tooltip: (cast iron or malleable iron and general use for all materials).
static final String	HATCHSTYLE_CORK_FELT_FABRIC_LEATHER_FIBRE	Tooltip: (cork, felt, fabric, leather, and fibre/fiber).
static final int	HATCHSTYLE_DEFAULT_VALUE	SFInt32 field named hatchStyle has default value 1 (Java syntax) or 1 (XML syntax).
static final String	HATCHSTYLE_EARTH	Tooltip: (earth).
static final String	HATCHSTYLE_HORIZONTAL	Tooltip: Horizontal equally spaced parallel lines.
static final String	HATCHSTYLE_HORIZONTAL_VERTICAL_CROSSHATCH	Tooltip: Horizontal/vertical crosshatch.
static final String	HATCHSTYLE_MAGNESIUM_ALUMINUM_ALLOYS	Tooltip: (magnesium, aluminum, and aluminum alloys).
static final String	HATCHSTYLE_MARBLE_SLATE_PORCELAIN_GLASS	Tooltip: (marble, slate, porcelain, glass, etc.).
static final String	HATCHSTYLE_NEGATIVE_SLOPE	Tooltip: Negative slope equally spaced parallel lines.
static final String	HATCHSTYLE_POSITIVE_NEGATIVE_SLOPE_CROSSHATCH	Tooltip: Positive slope/negative slope crosshatch.
static final String	HATCHSTYLE_POSITIVE_SLOPE	Tooltip: Positive slope equally spaced parallel lines.
static final String	HATCHSTYLE_REPEATING_DOT	Tooltip: (repeating dot).
static final String	HATCHSTYLE_RUBBER_PLASTIC_ELECTRICAL_INSULATION	Tooltip: (rubber, plastic, and electrical insulation).
static final String	HATCHSTYLE_SAND	Tooltip: (sand).
static final String	HATCHSTYLE_STEEL	Tooltip: (steel).
static final String	HATCHSTYLE_THERMAL_INSULATION	Tooltip: (thermal insulation).
static final String	HATCHSTYLE_TITANIUM	Tooltip: (titanium and refi-actory material).
static final String	HATCHSTYLE_VERTICAL	Tooltip: Vertical equally spaced parallel lines.
static final String	HATCHSTYLE_WHITE_METAL_ZINC_LEAD_BABBIT_ALLOYS	Tooltip: (white metal, zinc, lead, babbit, and alloys).
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 Shape component level for this element: 3
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: FillProperties.
static final String	toField_FILLED	toField ROUTE name for SFBool field named filled.
static final String	toField_HATCHCOLOR	toField ROUTE name for SFColor field named hatchColor.
static final String	toField_HATCHED	toField ROUTE name for SFBool field named hatched.
static final String	toField_HATCHSTYLE	toField ROUTE name for SFInt32 field named hatchStyle.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.

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
FillProperties()	Constructor for FillProperties to initialize member variables with default values.
FillProperties(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
FillProperties	addComments(String newComment)	Add comment as String to contained commentsList.
FillProperties	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
FillProperties	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
FillProperties	clearIS()	Utility method to clear SFNode value of IS field.
FillProperties	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.
final String	getComponent()	Defines X3D component for the FillProperties element: Shape
final int	getComponentLevel()	Provides default X3D component level for this element: 3
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: FillProperties
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
boolean	getFilled()	Provide boolean value from inputOutput SFBool field named filled.
float[]	getHatchColor()	Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named hatchColor.
boolean	getHatched()	Provide boolean value from inputOutput SFBool field named hatched.
int	getHatchStyle()	Provide int enumeration value (baseType SFInt32) ["1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19"] from inputOutput SFInt32 field named hatchStyle.
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.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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.
final FillProperties	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
FillProperties	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final FillProperties	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
FillProperties	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final FillProperties	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
FillProperties	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
FillProperties	setFilled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named filled.
FillProperties	setFilled(SFBool newValue)	Assign typed object value to SFBool filled field, similar to setFilled(boolean).
FillProperties	setHatchColor(double[] newArray)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setHatchColor(float[]).
FillProperties	setHatchColor(double red, double green, double blue)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setHatchColor(float[]).
FillProperties	setHatchColor(float[] newValue)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named hatchColor.
FillProperties	setHatchColor(float red, float green, float blue)	Assign values to SFColor hatchColor field, similar to setHatchColor(float[]).
FillProperties	setHatchColor(SFColor newValue)	Assign typed object value to SFColor hatchColor field, similar to setHatchColor(float[]).
FillProperties	setHatched(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named hatched.
FillProperties	setHatched(SFBool newValue)	Assign typed object value to SFBool hatched field, similar to setHatched(boolean).
FillProperties	setHatchStyle(int newValue)	Accessor method to assign int enumeration value ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19") to inputOutput SFInt32 field named hatchStyle.
FillProperties	setHatchStyle(SFInt32 newValue)	Assign typed object value to SFInt32 hatchStyle field, similar to setHatchStyle(int).
final FillProperties	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
FillProperties	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
FillProperties	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
FillProperties	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
FillProperties	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 FillProperties	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
FillProperties	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
FillProperties	setUSE(FillProperties 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 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

HATCHSTYLE_HORIZONTAL

public static final String HATCHSTYLE_HORIZONTAL

Tooltip: Horizontal equally spaced parallel lines. SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "1" (Java syntax) or 1 (XML syntax).

See Also:

• HATCHSTYLE_1_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_1_ALIAS

public static final String HATCHSTYLE_1_ALIAS

SFString SFInt32 enumeration value "1" has alias "HORIZONTAL"

See Also:

• HATCHSTYLE_HORIZONTAL
• Constant Field Values

HATCHSTYLE_VERTICAL

public static final String HATCHSTYLE_VERTICAL

Tooltip: Vertical equally spaced parallel lines. SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "2" (Java syntax) or 2 (XML syntax).

See Also:

• HATCHSTYLE_2_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_2_ALIAS

public static final String HATCHSTYLE_2_ALIAS

SFString SFInt32 enumeration value "2" has alias "VERTICAL"

See Also:

• HATCHSTYLE_VERTICAL
• Constant Field Values

HATCHSTYLE_POSITIVE_SLOPE

public static final String HATCHSTYLE_POSITIVE_SLOPE

Tooltip: Positive slope equally spaced parallel lines. SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "3" (Java syntax) or 3 (XML syntax).

See Also:

• HATCHSTYLE_3_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_3_ALIAS

public static final String HATCHSTYLE_3_ALIAS

SFString SFInt32 enumeration value "3" has alias "POSITIVE_SLOPE"

See Also:

• HATCHSTYLE_POSITIVE_SLOPE
• Constant Field Values

HATCHSTYLE_NEGATIVE_SLOPE

public static final String HATCHSTYLE_NEGATIVE_SLOPE

Tooltip: Negative slope equally spaced parallel lines. SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "4" (Java syntax) or 4 (XML syntax).

See Also:

• HATCHSTYLE_4_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_4_ALIAS

public static final String HATCHSTYLE_4_ALIAS

SFString SFInt32 enumeration value "4" has alias "NEGATIVE_SLOPE"

See Also:

• HATCHSTYLE_NEGATIVE_SLOPE
• Constant Field Values

HATCHSTYLE_HORIZONTAL_VERTICAL_CROSSHATCH

public static final String HATCHSTYLE_HORIZONTAL_VERTICAL_CROSSHATCH

Tooltip: Horizontal/vertical crosshatch. SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "5" (Java syntax) or 5 (XML syntax).

See Also:

• HATCHSTYLE_5_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_5_ALIAS

public static final String HATCHSTYLE_5_ALIAS

SFString SFInt32 enumeration value "5" has alias "HORIZONTAL_VERTICAL_CROSSHATCH"

See Also:

• HATCHSTYLE_HORIZONTAL_VERTICAL_CROSSHATCH
• Constant Field Values

HATCHSTYLE_POSITIVE_NEGATIVE_SLOPE_CROSSHATCH

public static final String HATCHSTYLE_POSITIVE_NEGATIVE_SLOPE_CROSSHATCH

Tooltip: Positive slope/negative slope crosshatch. SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "6" (Java syntax) or 6 (XML syntax).

See Also:

• HATCHSTYLE_6_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_6_ALIAS

public static final String HATCHSTYLE_6_ALIAS

SFString SFInt32 enumeration value "6" has alias "POSITIVE_NEGATIVE_SLOPE_CROSSHATCH"

See Also:

• HATCHSTYLE_POSITIVE_NEGATIVE_SLOPE_CROSSHATCH
• Constant Field Values

HATCHSTYLE_CAST_IRON

public static final String HATCHSTYLE_CAST_IRON

Tooltip: (cast iron or malleable iron and general use for all materials). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "7" (Java syntax) or 7 (XML syntax).

See Also:

• HATCHSTYLE_7_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_7_ALIAS

public static final String HATCHSTYLE_7_ALIAS

SFString SFInt32 enumeration value "7" has alias "CAST_IRON"

See Also:

• HATCHSTYLE_CAST_IRON
• Constant Field Values

HATCHSTYLE_STEEL

public static final String HATCHSTYLE_STEEL

Tooltip: (steel). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "8" (Java syntax) or 8 (XML syntax).

See Also:

• HATCHSTYLE_8_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_8_ALIAS

public static final String HATCHSTYLE_8_ALIAS

SFString SFInt32 enumeration value "8" has alias "STEEL"

See Also:

• HATCHSTYLE_STEEL
• Constant Field Values

HATCHSTYLE_BRONZE_BRASS_COPPER_COMPOSITIONS

public static final String HATCHSTYLE_BRONZE_BRASS_COPPER_COMPOSITIONS

Tooltip: (bronze, brass, copper, and compositions). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "9" (Java syntax) or 9 (XML syntax).

See Also:

• HATCHSTYLE_9_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_9_ALIAS

public static final String HATCHSTYLE_9_ALIAS

SFString SFInt32 enumeration value "9" has alias "BRONZE_BRASS_COPPER_COMPOSITIONS"

See Also:

• HATCHSTYLE_BRONZE_BRASS_COPPER_COMPOSITIONS
• Constant Field Values

HATCHSTYLE_WHITE_METAL_ZINC_LEAD_BABBIT_ALLOYS

public static final String HATCHSTYLE_WHITE_METAL_ZINC_LEAD_BABBIT_ALLOYS

Tooltip: (white metal, zinc, lead, babbit, and alloys). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "10" (Java syntax) or 10 (XML syntax).

See Also:

• HATCHSTYLE_10_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_10_ALIAS

public static final String HATCHSTYLE_10_ALIAS

SFString SFInt32 enumeration value "10" has alias "WHITE_METAL_ZINC_LEAD_BABBIT_ALLOYS"

See Also:

• HATCHSTYLE_WHITE_METAL_ZINC_LEAD_BABBIT_ALLOYS
• Constant Field Values

HATCHSTYLE_MAGNESIUM_ALUMINUM_ALLOYS

public static final String HATCHSTYLE_MAGNESIUM_ALUMINUM_ALLOYS

Tooltip: (magnesium, aluminum, and aluminum alloys). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "11" (Java syntax) or 11 (XML syntax).

See Also:

• HATCHSTYLE_11_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_11_ALIAS

public static final String HATCHSTYLE_11_ALIAS

SFString SFInt32 enumeration value "11" has alias "MAGNESIUM_ALUMINUM_ALLOYS"

See Also:

• HATCHSTYLE_MAGNESIUM_ALUMINUM_ALLOYS
• Constant Field Values

HATCHSTYLE_RUBBER_PLASTIC_ELECTRICAL_INSULATION

public static final String HATCHSTYLE_RUBBER_PLASTIC_ELECTRICAL_INSULATION

Tooltip: (rubber, plastic, and electrical insulation). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "12" (Java syntax) or 12 (XML syntax).

See Also:

• HATCHSTYLE_12_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_12_ALIAS

public static final String HATCHSTYLE_12_ALIAS

SFString SFInt32 enumeration value "12" has alias "RUBBER_PLASTIC_ELECTRICAL_INSULATION"

See Also:

• HATCHSTYLE_RUBBER_PLASTIC_ELECTRICAL_INSULATION
• Constant Field Values

HATCHSTYLE_CORK_FELT_FABRIC_LEATHER_FIBRE

public static final String HATCHSTYLE_CORK_FELT_FABRIC_LEATHER_FIBRE

Tooltip: (cork, felt, fabric, leather, and fibre/fiber). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "13" (Java syntax) or 13 (XML syntax).

See Also:

• HATCHSTYLE_13_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_13_ALIAS

public static final String HATCHSTYLE_13_ALIAS

SFString SFInt32 enumeration value "13" has alias "CORK_FELT_FABRIC_LEATHER_FIBRE"

See Also:

• HATCHSTYLE_CORK_FELT_FABRIC_LEATHER_FIBRE
• Constant Field Values

HATCHSTYLE_THERMAL_INSULATION

public static final String HATCHSTYLE_THERMAL_INSULATION

Tooltip: (thermal insulation). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "14" (Java syntax) or 14 (XML syntax).

See Also:

• HATCHSTYLE_14_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_14_ALIAS

public static final String HATCHSTYLE_14_ALIAS

SFString SFInt32 enumeration value "14" has alias "THERMAL_INSULATION"

See Also:

• HATCHSTYLE_THERMAL_INSULATION
• Constant Field Values

HATCHSTYLE_TITANIUM

public static final String HATCHSTYLE_TITANIUM

Tooltip: (titanium and refi-actory material). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "15" (Java syntax) or 15 (XML syntax).

See Also:

• HATCHSTYLE_15_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_15_ALIAS

public static final String HATCHSTYLE_15_ALIAS

SFString SFInt32 enumeration value "15" has alias "TITANIUM"

See Also:

• HATCHSTYLE_TITANIUM
• Constant Field Values

HATCHSTYLE_MARBLE_SLATE_PORCELAIN_GLASS

public static final String HATCHSTYLE_MARBLE_SLATE_PORCELAIN_GLASS

Tooltip: (marble, slate, porcelain, glass, etc.). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "16" (Java syntax) or 16 (XML syntax).

See Also:

• HATCHSTYLE_16_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_16_ALIAS

public static final String HATCHSTYLE_16_ALIAS

SFString SFInt32 enumeration value "16" has alias "MARBLE_SLATE_PORCELAIN_GLASS"

See Also:

• HATCHSTYLE_MARBLE_SLATE_PORCELAIN_GLASS
• Constant Field Values

HATCHSTYLE_EARTH

public static final String HATCHSTYLE_EARTH

Tooltip: (earth). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "17" (Java syntax) or 17 (XML syntax).

See Also:

• HATCHSTYLE_17_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_17_ALIAS

public static final String HATCHSTYLE_17_ALIAS

SFString SFInt32 enumeration value "17" has alias "EARTH"

See Also:

• HATCHSTYLE_EARTH
• Constant Field Values

HATCHSTYLE_SAND

public static final String HATCHSTYLE_SAND

Tooltip: (sand). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "18" (Java syntax) or 18 (XML syntax).

See Also:

• HATCHSTYLE_18_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_18_ALIAS

public static final String HATCHSTYLE_18_ALIAS

SFString SFInt32 enumeration value "18" has alias "SAND"

See Also:

• HATCHSTYLE_SAND
• Constant Field Values

HATCHSTYLE_REPEATING_DOT

public static final String HATCHSTYLE_REPEATING_DOT

Tooltip: (repeating dot). SFInt32 field named hatchStyle with X3DUOM simpleType hatchStyleValues and with X3DUOM baseType SFInt32 "19" (Java syntax) or 19 (XML syntax).

See Also:

• HATCHSTYLE_19_ALIAS
• XML Schema: hatchStyleValues
• Constant Field Values

HATCHSTYLE_19_ALIAS

public static final String HATCHSTYLE_19_ALIAS

SFString SFInt32 enumeration value "19" has alias "REPEATING_DOT"

See Also:

• HATCHSTYLE_REPEATING_DOT
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: FillProperties.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the FillProperties element: Shape

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Shape component level for this element: 3

See Also:

• Constant Field Values

FILLED_DEFAULT_VALUE

public static final boolean FILLED_DEFAULT_VALUE

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

See Also:

• Constant Field Values

HATCHCOLOR_DEFAULT_VALUE

public static final float[] HATCHCOLOR_DEFAULT_VALUE

SFColor field named hatchColor has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).

HATCHED_DEFAULT_VALUE

public static final boolean HATCHED_DEFAULT_VALUE

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

See Also:

• Constant Field Values

HATCHSTYLE_DEFAULT_VALUE

public static final int HATCHSTYLE_DEFAULT_VALUE

SFInt32 field named hatchStyle has default value 1 (Java syntax) or 1 (XML syntax).

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

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_FILLED

public static final String fromField_FILLED

fromField ROUTE name for SFBool field named filled.

See Also:

• Constant Field Values

toField_FILLED

public static final String toField_FILLED

toField ROUTE name for SFBool field named filled.

See Also:

• Constant Field Values

fromField_HATCHCOLOR

public static final String fromField_HATCHCOLOR

fromField ROUTE name for SFColor field named hatchColor.

See Also:

• Constant Field Values

toField_HATCHCOLOR

public static final String toField_HATCHCOLOR

toField ROUTE name for SFColor field named hatchColor.

See Also:

• Constant Field Values

fromField_HATCHED

public static final String fromField_HATCHED

fromField ROUTE name for SFBool field named hatched.

See Also:

• Constant Field Values

toField_HATCHED

public static final String toField_HATCHED

toField ROUTE name for SFBool field named hatched.

See Also:

• Constant Field Values

fromField_HATCHSTYLE

public static final String fromField_HATCHSTYLE

fromField ROUTE name for SFInt32 field named hatchStyle.

See Also:

• Constant Field Values

toField_HATCHSTYLE

public static final String toField_HATCHSTYLE

toField ROUTE name for SFInt32 field named hatchStyle.

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

Constructor Details

FillProperties

public FillProperties()

Constructor for FillProperties to initialize member variables with default values.

FillProperties

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the FillProperties element: Shape

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

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

getFilled

public boolean getFilled()

Provide boolean value from inputOutput SFBool field named filled.

Tooltip: Whether or not associated geometry is filled. *

Specified by:

getFilled in interface FillProperties

Returns:

value of filled field

setFilled

public FillProperties setFilled(boolean newValue)

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

Tooltip: Whether or not associated geometry is filled. *

Specified by:

setFilled in interface FillProperties

Parameters:

newValue - is new value for the filled field.

Returns:

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

setFilled

public FillProperties setFilled(SFBool newValue)

Assign typed object value to SFBool filled field, similar to setFilled(boolean).

Parameters:

newValue - is new value for the filled field.

Returns:

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

getHatchColor

public float[] getHatchColor()

Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named hatchColor.

Tooltip: [0,1] Color of the hatch pattern. *

Specified by:

getHatchColor in interface FillProperties

Returns:

value of hatchColor field

setHatchColor

public FillProperties setHatchColor(float[] newValue)

Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named hatchColor.

Tooltip: [0,1] Color of the hatch pattern. *

Specified by:

setHatchColor in interface FillProperties

Parameters:

newValue - is new value for the hatchColor field.

Returns:

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

setHatchColor

public FillProperties setHatchColor(SFColor newValue)

Assign typed object value to SFColor hatchColor field, similar to setHatchColor(float[]).

Parameters:

newValue - is new value for the hatchColor field.

Returns:

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

setHatchColor

public FillProperties setHatchColor(float red,
 float green,
 float blue)

Assign values to SFColor hatchColor field, similar to setHatchColor(float[]).

Parameters:

red - first component

green - second component

blue - third component

Returns:

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

setHatchColor

public FillProperties setHatchColor(double red,
 double green,
 double blue)

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

Parameters:

red - first component [0..1]

green - second component [0..1]

blue - third component [0..1]

Returns:

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

setHatchColor

public FillProperties setHatchColor(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

getHatched

public boolean getHatched()

Provide boolean value from inputOutput SFBool field named hatched.

Tooltip: Whether or not associated geometry is hatched. *

Specified by:

getHatched in interface FillProperties

Returns:

value of hatched field

setHatched

public FillProperties setHatched(boolean newValue)

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

Tooltip: Whether or not associated geometry is hatched. *

Specified by:

setHatched in interface FillProperties

Parameters:

newValue - is new value for the hatched field.

Returns:

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

setHatched

public FillProperties setHatched(SFBool newValue)

Assign typed object value to SFBool hatched field, similar to setHatched(boolean).

Parameters:

newValue - is new value for the hatched field.

Returns:

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

getHatchStyle

public int getHatchStyle()

Provide int enumeration value (baseType SFInt32) ["1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19"] from inputOutput SFInt32 field named hatchStyle.

Tooltip: hatchStyle selects a hatch pattern from ISO/IEC 9973 International Register of Graphical Items. 1=Horizontal equally spaced parallel lines. 2=Vertical equally spaced parallel lines. 3=Positive slope equally spaced parallel lines. 4=Negative slope equally spaced parallel lines. 5=Horizontal/vertical crosshatch. 6=Positive slope/negative slope crosshatch. 7=(cast iron or malleable iron and general use for all materials). 8=(steel). 9=(bronze, brass, copper, and compositions). 10=(white metal, zinc, lead, babbit, and alloys). 11=(magnesium, aluminum, and aluminum alloys). 12=(rubber, plastic, and electrical insulation). 13=(cork, felt, fabric, leather, and fibre). 14=(thermal insulation). 15=(titanium and refi-actory material). 16=(marble, slate, porcelain, glass, etc.). 17=(earth). 18=(sand). 19=(repeating dot).

• Hint: detailed descriptions of hatchstyle values are found at the ISO/IEC 9973 International Register of Graphical Items https://www.iso.org/jtc1/sc24/register at https://isotc.iso.org/livelink/livelink/fetch/-8916524/8916549/8916590/6208440/class_pages/hatchstyle.html

Specified by:

getHatchStyle in interface FillProperties

Returns:

value of hatchStyle field

setHatchStyle

public FillProperties setHatchStyle(int newValue)

Accessor method to assign int enumeration value ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19") to inputOutput SFInt32 field named hatchStyle.

Tooltip: hatchStyle selects a hatch pattern from ISO/IEC 9973 International Register of Graphical Items. 1=Horizontal equally spaced parallel lines. 2=Vertical equally spaced parallel lines. 3=Positive slope equally spaced parallel lines. 4=Negative slope equally spaced parallel lines. 5=Horizontal/vertical crosshatch. 6=Positive slope/negative slope crosshatch. 7=(cast iron or malleable iron and general use for all materials). 8=(steel). 9=(bronze, brass, copper, and compositions). 10=(white metal, zinc, lead, babbit, and alloys). 11=(magnesium, aluminum, and aluminum alloys). 12=(rubber, plastic, and electrical insulation). 13=(cork, felt, fabric, leather, and fibre). 14=(thermal insulation). 15=(titanium and refi-actory material). 16=(marble, slate, porcelain, glass, etc.). 17=(earth). 18=(sand). 19=(repeating dot).

• Hint: detailed descriptions of hatchstyle values are found at the ISO/IEC 9973 International Register of Graphical Items https://www.iso.org/jtc1/sc24/register at https://isotc.iso.org/livelink/livelink/fetch/-8916524/8916549/8916590/6208440/class_pages/hatchstyle.html

Specified by:

setHatchStyle in interface FillProperties

Parameters:

newValue - is new value for the hatchStyle field.

Returns:

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

setHatchStyle

public FillProperties setHatchStyle(SFInt32 newValue)

Assign typed object value to SFInt32 hatchStyle field, similar to setHatchStyle(int).

Parameters:

newValue - is new value for the hatchStyle field.

Returns:

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

Specified by:

getMetadata in interface X3DAppearanceChildNode

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

Specified by:

setMetadata in interface X3DAppearanceChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

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

setDEF

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

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

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

setUSE

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

FillProperties - 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 Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final FillProperties 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:

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

FillProperties - 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 Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final FillProperties 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:

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

FillProperties - 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 Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final FillProperties 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:

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

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

setUSE

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

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

addComments

public FillProperties addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public FillProperties addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public FillProperties addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

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)