public class LayerSetObject extends X3DConcreteNode implements LayerSet
Modifier and Type | Field and Description |
---|---|
static int |
ACTIVELAYER_DEFAULT_VALUE
SFInt32 field named activeLayer has default value 0 (Java syntax) or 0 (XML syntax).
|
static java.lang.String |
COMPONENT
String constant COMPONENT defines X3D component for the LayerSet element: Layering
|
static java.lang.String |
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.
|
static java.lang.String |
fromField_ACTIVELAYER
fromField ROUTE name for SFInt32 field named activeLayer.
|
static java.lang.String |
fromField_LAYERS
fromField ROUTE name for MFNode field named layers.
|
static java.lang.String |
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.
|
static int |
LEVEL
Integer constant LEVEL provides default X3D Layering component level for this element: 1
|
static java.lang.String |
NAME
String constant NAME provides name of this element: LayerSet.
|
static java.util.ArrayList<java.lang.Integer> |
ORDER_DEFAULT_VALUE
MFInt32 field named order has default value {0} (Java syntax) or 0 (XML syntax).
|
static java.lang.String |
toField_ACTIVELAYER
toField ROUTE name for SFInt32 field named activeLayer.
|
static java.lang.String |
toField_LAYERS
toField ROUTE name for MFNode field named layers.
|
static java.lang.String |
toField_METADATA
toField ROUTE name for SFNode field named metadata.
|
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
validationResult
Constructor and Description |
---|
LayerSetObject()
Constructor for LayerSetObject to initialize member variables with default values.
|
LayerSetObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values.
|
Modifier and Type | Method and Description |
---|---|
LayerSetObject |
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.
|
LayerSetObject |
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.
|
LayerSetObject |
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.
|
LayerSetObject |
addLayers(X3DNode newValue)
Add single child node to existing array of layers nodes (if any).
|
void |
addLayers(X3DNode[] newValue)
Add array of child layers nodes to array of existing nodes (if any).
|
LayerSetObject |
addOrder(int newValue)
Add singleton int value to MFInt32 order field.
|
LayerSetObject |
addOrder(SFInt32Object newValue)
Add singleton SFInt32Object value to MFInt32 order field.
|
LayerSetObject |
clearLayers()
Utility method to clear MFNode value of layers field.
|
LayerSetObject |
clearMetadata()
Utility method to clear SFNode value of metadata field.
|
LayerSetObject |
clearOrder()
Utility method to clear MFInt32 value of order field.
|
X3DConcreteElement |
findElementByNameValue(java.lang.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(java.lang.String nameValue,
java.lang.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(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
|
java.lang.String |
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.
|
int |
getActiveLayer()
Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named activeLayer.
|
java.lang.String |
getComponent()
Defines X3D component for the LayerSet element: Layering
|
int |
getComponentLevel()
Provides default X3D component level for this element: 1
|
java.lang.String |
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.
|
java.lang.String |
getElementName()
Provides name of this element: LayerSet
|
java.lang.String |
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.
|
ISObject |
getIS()
Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
|
X3DNode[] |
getLayers()
Provide array of X3DLayerNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field layers.
|
java.util.ArrayList<X3DNode> |
getLayersList()
Utility method to get ArrayList value of MFNode layers field, similar to
getLayers() . |
X3DMetadataObject |
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
|
int[] |
getOrder()
Provide array of Integer results within allowed range of [0,infinity) from initializeOnly MFInt32 field named order.
|
java.util.ArrayList<java.lang.Integer> |
getOrderList()
Utility method to get ArrayList value of MFInt32 order field, similar to
getOrder() . |
boolean |
hasElementByNameValue(java.lang.String nameValue,
java.lang.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 |
hasLayers()
Indicate whether an object is available for inputOutput MFNode field layers.
|
boolean |
hasMetadata()
Indicate whether an object is available for inputOutput SFNode field metadata.
|
boolean |
hasNodeByDEF(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
|
void |
initialize()
Initialize all member variables to default values.
|
LayerSetObject |
setActiveLayer(int newValue)
Assign int value within allowed range of [0,infinity) to inputOutput SFInt32 field named activeLayer.
|
LayerSetObject |
setActiveLayer(SFInt32Object newValue)
Assign typed object value to SFInt32 activeLayer field, similar to
setActiveLayer(int) . |
LayerSetObject |
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar to
setCssClass(String) . |
LayerSetObject |
setCssClass(java.lang.String newValue)
Assign String value to inputOutput SFString field named class.
|
LayerSetObject |
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar to
setDEF(String) . |
LayerSetObject |
setDEF(java.lang.String newValue)
Assign String value to inputOutput SFString field named DEF.
|
LayerSetObject |
setIS(ISObject newValue)
Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
|
LayerSetObject |
setLayers(java.util.ArrayList<X3DLayerNode> newValue)
Assign ArrayList value of MFNode layers field, similar to
setLayers(X3DNode[]) . |
LayerSetObject |
setLayers(X3DConcreteNode newValue)
Utility method to set single SFNode as LayerSetObject layers.
|
void |
setLayers(X3DNode newValue)
Set single child layers node, replacing prior array of existing nodes (if any).
|
LayerSetObject |
setLayers(X3DNode[] newValue)
Assign X3DLayerNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field layers.
|
LayerSetObject |
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
|
LayerSetObject |
setMetadata(X3DMetadataObject newValue)
Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
|
LayerSetObject |
setOrder(java.util.ArrayList<java.lang.Integer> newValue)
Assign ArrayList value of MFInt32 order field, similar to
setOrder(int[]) . |
LayerSetObject |
setOrder(int[] newValue)
Assign Integer array within allowed range of [0,infinity) to initializeOnly MFInt32 field named order.
|
LayerSetObject |
setOrder(MFInt32Object newValue)
Assign typed object value to MFInt32 order field, similar to
setOrder(int[]) . |
LayerSetObject |
setUSE(LayerSetObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar to
setUSE(String) . |
LayerSetObject |
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar to
setUSE(String) . |
LayerSetObject |
setUSE(java.lang.String newValue)
Assign String value to inputOutput SFString field named USE.
|
java.lang.String |
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.
|
java.lang.String |
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.
|
java.lang.String |
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
|
java.lang.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.
|
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
public static final java.lang.String NAME
public static final java.lang.String COMPONENT
public static final int LEVEL
public static final int ACTIVELAYER_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Integer> ORDER_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUE
public static final java.lang.String fromField_ACTIVELAYER
public static final java.lang.String toField_ACTIVELAYER
public static final java.lang.String fromField_LAYERS
public static final java.lang.String toField_LAYERS
public static final java.lang.String fromField_METADATA
public static final java.lang.String toField_METADATA
public LayerSetObject()
public LayerSetObject(java.lang.String DEFlabel)
DEFlabel
- unique DEF name for this X3D nodepublic final java.lang.String getElementName()
getElementName
in class X3DConcreteElement
public final java.lang.String getComponent()
getComponent
in class X3DConcreteElement
public final int getComponentLevel()
getComponentLevel
in class X3DConcreteElement
public java.lang.String getFieldType(java.lang.String fieldName)
getFieldType
in class X3DConcreteElement
fieldName
- name of field in this X3D nodeConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
public java.lang.String getAccessType(java.lang.String fieldName)
getAccessType
in class X3DConcreteElement
fieldName
- name of field in this X3D nodeConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
public final java.lang.String getContainerFieldDefault()
getContainerFieldDefault
in class X3DConcreteNode
public final void initialize()
initialize
in class X3DConcreteNode
public int getActiveLayer()
getActiveLayer
in interface LayerSet
public LayerSetObject setActiveLayer(int newValue)
setActiveLayer
in interface LayerSet
newValue
- is new value for the activeLayer field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject setActiveLayer(SFInt32Object newValue)
setActiveLayer(int)
.newValue
- is new value for the activeLayer field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public X3DNode[] getLayers()
getLayers
in interface LayerSet
X3DLayerNode
public java.util.ArrayList<X3DNode> getLayersList()
getLayers()
.public LayerSetObject setLayers(X3DNode[] newValue)
setLayers
in interface LayerSet
newValue
- is new value for the layers field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject setLayers(java.util.ArrayList<X3DLayerNode> newValue)
setLayers(X3DNode[])
.newValue
- is new value for the layers field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject addLayers(X3DNode newValue)
newValue
- is new value to be appended the layers field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public void addLayers(X3DNode[] newValue)
public void setLayers(X3DNode newValue)
public LayerSetObject setLayers(X3DConcreteNode newValue)
newValue
- LayerSetObject node to setLayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public LayerSetObject clearLayers()
LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public boolean hasLayers()
getLayers()
public X3DMetadataObject getMetadata()
getMetadata
in interface X3DNode
getMetadata
in interface LayerSet
getMetadataProtoInstance()
,
X3D Scene Authoring Hints: Metadata Nodespublic LayerSetObject setMetadata(X3DMetadataObject newValue)
setMetadata
in interface X3DNode
setMetadata
in interface LayerSet
setMetadata
in class X3DConcreteNode
newValue
- is new value for the metadata field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).setMetadata(ProtoInstanceObject)
,
X3D Scene Authoring Hints: Metadata Nodespublic LayerSetObject clearMetadata()
LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public LayerSetObject setMetadata(ProtoInstanceObject newValue)
setMetadata
in class X3DConcreteNode
newValue
- is new value for the metadata field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).setMetadata(X3DMetadataObject)
public boolean hasMetadata()
getMetadata()
,
getMetadataProtoInstance()
,
X3D Scene Authoring Hints: Metadata Nodespublic int[] getOrder()
public java.util.ArrayList<java.lang.Integer> getOrderList()
getOrder()
.public LayerSetObject setOrder(int[] newValue)
setOrder
in interface LayerSet
newValue
- is new value for the order field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject setOrder(MFInt32Object newValue)
setOrder(int[])
.newValue
- is new value for the order field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject setOrder(java.util.ArrayList<java.lang.Integer> newValue)
setOrder(int[])
.newValue
- is new value for the order field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject clearOrder()
LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public LayerSetObject addOrder(int newValue)
newValue
- is new value to add to the order field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject addOrder(SFInt32Object newValue)
newValue
- is new value to add to the order field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final LayerSetObject setDEF(java.lang.String newValue)
setDEF
in interface X3DNode
setDEF
in interface LayerSet
setDEF
in class X3DConcreteNode
newValue
- is new value for the DEF field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject setDEF(SFStringObject newValue)
setDEF(String)
.newValue
- is new value for the DEF field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final LayerSetObject setUSE(java.lang.String newValue)
USE
node is still an independent object, with the USE
value matching the DEF
value in the preceding object.
setUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.setUSE
in interface X3DNode
setUSE
in interface LayerSet
setUSE
in class X3DConcreteNode
newValue
- is new value for the USE field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject setUSE(SFStringObject newValue)
setUSE(String)
.newValue
- is new value for the USE field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final LayerSetObject setCssClass(java.lang.String newValue)
setCssClass
in interface X3DNode
setCssClass
in interface LayerSet
setCssClass
in class X3DConcreteNode
newValue
- is new value for the class field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject setCssClass(SFStringObject newValue)
setCssClass(String)
.newValue
- is new value for the class field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject setIS(ISObject newValue)
setIS
in class X3DConcreteNode
newValue
- is new value for the description field.LayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ISObject getIS()
getIS
in class X3DConcreteNode
public LayerSetObject setUSE(LayerSetObject DEFnode)
setUSE(String)
.
setUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
DEFnode
- must have a DEF value definedLayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public LayerSetObject addComments(java.lang.String newComment)
addComments
in class X3DConcreteElement
newComment
- initial valueLayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public LayerSetObject addComments(java.lang.String[] newComments)
addComments
in class X3DConcreteElement
newComments
- array of commentsLayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public LayerSetObject addComments(CommentsBlock newCommentsBlock)
addComments
in class X3DConcreteElement
newCommentsBlock
- block of comments to addLayerSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public java.lang.String toStringX3D(int indentLevel)
toStringX3D
in class X3DConcreteElement
indentLevel
- number of levels of indentation for this elementX3DObject.FILE_EXTENSION_X3D
,
X3DObject.FILE_EXTENSION_XML
,
X3DObject.toStringXML()
,
X3DObject.toFileXML(String)
,
X3DObject.toFileX3D(String)
,
X3D XML Encoding,
X3D Compressed Binary Encoding: X3D Canonical Formpublic java.lang.String toStringClassicVRML(int indentLevel)
toStringClassicVRML
in class X3DConcreteElement
indentLevel
- number of levels of indentation for this elementX3DObject.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: Grammarpublic java.lang.String toStringVRML97(int indentLevel)
toStringVRML97
in class X3DConcreteElement
indentLevel
- number of levels of indentation for this elementX3DObject.FILE_EXTENSION_VRML97
,
X3D Resources: Virtual Reality Modeling Language (VRML) 97,
Virtual Reality Modeling Language (VRML) 97 specification,
VRML 97 v2.1 Amendmentpublic X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
findElementByNameValue
in class X3DConcreteElement
nameValue
- is value of the name field being searched for in this element and child elements(if any)findNodeByDEF(String)
,
X3DConcreteElement.hasAncestorSceneObject()
,
X3DConcreteElement.findAncestorX3DObject()
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
findElementByNameValue
in class X3DConcreteElement
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.)findNodeByDEF(String)
,
X3DConcreteElement.hasAncestorSceneObject()
,
X3DConcreteElement.findAncestorX3DObject()
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
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.)findElementByNameValue(String, String)
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
findNodeByDEF
in class X3DConcreteElement
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)findElementByNameValue(String)
,
X3DConcreteElement.hasAncestorSceneObject()
,
X3DConcreteElement.findAncestorX3DObject()
public boolean hasNodeByDEF(java.lang.String DEFvalue)
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)findNodeByDEF(String)
public java.lang.String validate()
validate
in class X3DConcreteElement
Copyright ©2005-2017 Web3D Consortium under an open-source license, free for any use. Feedback is welcome.