public class ClipPlaneObject extends X3DConcreteNode implements ClipPlane
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENT
String constant COMPONENT defines X3D component for the ClipPlane element: Rendering
|
static java.lang.String |
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.
|
static boolean |
ENABLED_DEFAULT_VALUE
SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
|
static java.lang.String |
fromField_ENABLED
fromField ROUTE name for SFBool field named enabled.
|
static java.lang.String |
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.
|
static java.lang.String |
fromField_PLANE
fromField ROUTE name for SFVec4f field named plane.
|
static int |
LEVEL
Integer constant LEVEL provides default X3D Rendering component level for this element: 5
|
static java.lang.String |
NAME
String constant NAME provides name of this element: ClipPlane.
|
static float[] |
PLANE_DEFAULT_VALUE
SFVec4f field named plane has default value {0f,1f,0f,0f} (Java syntax) or 0 1 0 0 (XML syntax).
|
static java.lang.String |
toField_ENABLED
toField ROUTE name for SFBool field named enabled.
|
static java.lang.String |
toField_METADATA
toField ROUTE name for SFNode field named metadata.
|
static java.lang.String |
toField_PLANE
toField ROUTE name for SFVec4f field named plane.
|
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
validationResult
Constructor and Description |
---|
ClipPlaneObject()
Constructor for ClipPlaneObject to initialize member variables with default values.
|
ClipPlaneObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values.
|
Modifier and Type | Method and Description |
---|---|
ClipPlaneObject |
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.
|
ClipPlaneObject |
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.
|
ClipPlaneObject |
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.
|
ClipPlaneObject |
clearMetadata()
Utility method to clear SFNode value of metadata 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.
|
java.lang.String |
getComponent()
Defines X3D component for the ClipPlane element: Rendering
|
int |
getComponentLevel()
Provides default X3D component level for this element: 5
|
java.lang.String |
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.
|
java.lang.String |
getElementName()
Provides name of this element: ClipPlane
|
boolean |
getEnabled()
Provide boolean value from inputOutput SFBool field named enabled.
|
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.
|
X3DMetadataObject |
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
|
float[] |
getPlane()
Provide array of 4-tuple float results within allowed range of [-1,1] from inputOutput SFVec4f field named plane.
|
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 |
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.
|
ClipPlaneObject |
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar to
setCssClass(String) . |
ClipPlaneObject |
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.
|
ClipPlaneObject |
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar to
setDEF(String) . |
ClipPlaneObject |
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.
|
ClipPlaneObject |
setEnabled(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named enabled.
|
ClipPlaneObject |
setEnabled(SFBoolObject newValue)
Assign typed object value to SFBool enabled field, similar to
setEnabled(boolean) . |
ClipPlaneObject |
setIS(ISObject newValue)
Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
|
ClipPlaneObject |
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
|
ClipPlaneObject |
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
|
ClipPlaneObject |
setPlane(float[] newValue)
Accessor method to assign 4-tuple float array to inputOutput SFVec4f field named plane.
|
ClipPlaneObject |
setPlane(float x,
float y,
float z,
float w)
Assign values to SFVec4f plane field, similar to
setPlane(float[]) . |
ClipPlaneObject |
setPlane(SFVec4fObject newValue)
Assign typed object value to SFVec4f plane field, similar to
setPlane(float[]) . |
ClipPlaneObject |
setUSE(ClipPlaneObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar to
setUSE(String) . |
ClipPlaneObject |
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar to
setUSE(String) . |
ClipPlaneObject |
setUSE(java.lang.String newValue)
Accessor method to 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 boolean ENABLED_DEFAULT_VALUE
public static final float[] PLANE_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUE
public static final java.lang.String fromField_ENABLED
public static final java.lang.String toField_ENABLED
public static final java.lang.String fromField_METADATA
public static final java.lang.String toField_METADATA
public static final java.lang.String fromField_PLANE
public static final java.lang.String toField_PLANE
public ClipPlaneObject()
public ClipPlaneObject(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 boolean getEnabled()
getEnabled
in interface ClipPlane
public ClipPlaneObject setEnabled(boolean newValue)
setEnabled
in interface ClipPlane
newValue
- is new value for the enabled field.ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ClipPlaneObject setEnabled(SFBoolObject newValue)
setEnabled(boolean)
.newValue
- is new value for the enabled field.ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public X3DMetadataObject getMetadata()
getMetadata
in interface X3DChildNode
getMetadata
in interface X3DNode
getMetadata
in interface ClipPlane
getMetadataProtoInstance()
,
X3D Scene Authoring Hints: Metadata Nodespublic ClipPlaneObject setMetadata(X3DMetadataObject newValue)
setMetadata
in interface X3DChildNode
setMetadata
in interface X3DNode
setMetadata
in interface ClipPlane
setMetadata
in class X3DConcreteNode
newValue
- is new value for the metadata field.ClipPlaneObject
- 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 ClipPlaneObject clearMetadata()
ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public ClipPlaneObject setMetadata(ProtoInstanceObject newValue)
setMetadata
in class X3DConcreteNode
newValue
- is new value for the metadata field.ClipPlaneObject
- 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 float[] getPlane()
public ClipPlaneObject setPlane(float[] newValue)
setPlane
in interface ClipPlane
newValue
- is new value for the plane field.ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ClipPlaneObject setPlane(SFVec4fObject newValue)
setPlane(float[])
.newValue
- is new value for the plane field.ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ClipPlaneObject setPlane(float x, float y, float z, float w)
setPlane(float[])
.x
- first componenty
- second componentz
- third componentw
- fourth componentClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final ClipPlaneObject setDEF(java.lang.String newValue)
setDEF
in interface X3DChildNode
setDEF
in interface X3DNode
setDEF
in interface ClipPlane
setDEF
in class X3DConcreteNode
newValue
- is new value for the DEF field.ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ClipPlaneObject setDEF(SFStringObject newValue)
setDEF(String)
.newValue
- is new value for the DEF field.ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final ClipPlaneObject 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 X3DChildNode
setUSE
in interface X3DNode
setUSE
in interface ClipPlane
setUSE
in class X3DConcreteNode
newValue
- is new value for the USE field.ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ClipPlaneObject setUSE(SFStringObject newValue)
setUSE(String)
.newValue
- is new value for the USE field.ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final ClipPlaneObject setCssClass(java.lang.String newValue)
setCssClass
in interface X3DChildNode
setCssClass
in interface X3DNode
setCssClass
in interface ClipPlane
setCssClass
in class X3DConcreteNode
newValue
- is new value for the class field.ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ClipPlaneObject setCssClass(SFStringObject newValue)
setCssClass(String)
.newValue
- is new value for the class field.ClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ClipPlaneObject setIS(ISObject newValue)
setIS
in class X3DConcreteNode
newValue
- is new value for the description field.ClipPlaneObject
- 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 ClipPlaneObject setUSE(ClipPlaneObject 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 definedClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ClipPlaneObject addComments(java.lang.String newComment)
addComments
in class X3DConcreteElement
newComment
- initial valueClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public ClipPlaneObject addComments(java.lang.String[] newComments)
addComments
in class X3DConcreteElement
newComments
- array of commentsClipPlaneObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public ClipPlaneObject addComments(CommentsBlock newCommentsBlock)
addComments
in class X3DConcreteElement
newCommentsBlock
- block of comments to addClipPlaneObject
- 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 Form,
X3D Canonicalization (C14N) Toolpublic 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.