public class ConeObject extends X3DConcreteNode implements Cone
| Modifier and Type | Field and Description |
|---|---|
static boolean |
BOTTOM_DEFAULT_VALUE
SFBool field named bottom has default value true (Java syntax) or true (XML syntax).
|
static float |
BOTTOMRADIUS_DEFAULT_VALUE
SFFloat field named bottomRadius has default value 1f (Java syntax) or 1 (XML syntax).
|
static java.lang.String |
COMPONENT
String constant COMPONENT defines X3D component for the Cone element: Geometry3D
|
static java.lang.String |
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.
|
static java.lang.String |
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.
|
static float |
HEIGHT_DEFAULT_VALUE
SFFloat field named height has default value 2f (Java syntax) or 2 (XML syntax).
|
static int |
LEVEL
Integer constant LEVEL provides default X3D Geometry3D component level for this element: 1
|
static java.lang.String |
NAME
String constant NAME provides name of this element: Cone.
|
static boolean |
SIDE_DEFAULT_VALUE
SFBool field named side has default value true (Java syntax) or true (XML syntax).
|
static boolean |
SOLID_DEFAULT_VALUE
SFBool field named solid has default value true (Java syntax) or true (XML syntax).
|
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_VALUEvalidationResult| Constructor and Description |
|---|
ConeObject()
Constructor for ConeObject to initialize member variables with default values.
|
ConeObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values.
|
| Modifier and Type | Method and Description |
|---|---|
ConeObject |
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.
|
ConeObject |
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.
|
ConeObject |
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.
|
ConeObject |
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.
|
boolean |
getBottom()
Provide boolean value from initializeOnly SFBool field named bottom.
|
float |
getBottomRadius()
Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named bottomRadius.
|
java.lang.String |
getComponent()
Defines X3D component for the Cone element: Geometry3D
|
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: Cone
|
java.lang.String |
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.
|
float |
getHeight()
Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named height.
|
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.
|
boolean |
getSide()
Provide boolean value from initializeOnly SFBool field named side.
|
boolean |
getSolid()
Provide boolean value from initializeOnly SFBool field named solid.
|
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.
|
ConeObject |
setBottom(boolean newValue)
Assign boolean value to initializeOnly SFBool field named bottom.
|
ConeObject |
setBottom(SFBoolObject newValue)
Assign typed object value to SFBool bottom field, similar to
setBottom(boolean). |
ConeObject |
setBottomRadius(float newValue)
Assign float value within allowed range of (0,infinity) to initializeOnly SFFloat field named bottomRadius.
|
ConeObject |
setBottomRadius(SFFloatObject newValue)
Assign typed object value to SFFloat bottomRadius field, similar to
setBottomRadius(float). |
ConeObject |
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar to
setCssClass(String). |
ConeObject |
setCssClass(java.lang.String newValue)
Assign String value to inputOutput SFString field named class.
|
ConeObject |
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar to
setDEF(String). |
ConeObject |
setDEF(java.lang.String newValue)
Assign String value to inputOutput SFString field named DEF.
|
ConeObject |
setHeight(float newValue)
Assign float value within allowed range of (0,infinity) to initializeOnly SFFloat field named height.
|
ConeObject |
setHeight(SFFloatObject newValue)
Assign typed object value to SFFloat height field, similar to
setHeight(float). |
ConeObject |
setIS(ISObject newValue)
Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
|
ConeObject |
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
|
ConeObject |
setMetadata(X3DMetadataObject newValue)
Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
|
ConeObject |
setSide(boolean newValue)
Assign boolean value to initializeOnly SFBool field named side.
|
ConeObject |
setSide(SFBoolObject newValue)
Assign typed object value to SFBool side field, similar to
setSide(boolean). |
ConeObject |
setSolid(boolean newValue)
Assign boolean value to initializeOnly SFBool field named solid.
|
ConeObject |
setSolid(SFBoolObject newValue)
Assign typed object value to SFBool solid field, similar to
setSolid(boolean). |
ConeObject |
setUSE(ConeObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar to
setUSE(String). |
ConeObject |
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar to
setUSE(String). |
ConeObject |
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, setContainerFieldOverrideclearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3Dpublic static final java.lang.String NAME
public static final java.lang.String COMPONENT
public static final int LEVEL
public static final boolean BOTTOM_DEFAULT_VALUE
public static final float BOTTOMRADIUS_DEFAULT_VALUE
public static final float HEIGHT_DEFAULT_VALUE
public static final boolean SIDE_DEFAULT_VALUE
public static final boolean SOLID_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUE
public static final java.lang.String fromField_METADATA
public static final java.lang.String toField_METADATA
public ConeObject()
public ConeObject(java.lang.String DEFlabel)
DEFlabel - unique DEF name for this X3D nodepublic final java.lang.String getElementName()
getElementName in class X3DConcreteElementpublic final java.lang.String getComponent()
getComponent in class X3DConcreteElementpublic final int getComponentLevel()
getComponentLevel in class X3DConcreteElementpublic java.lang.String getFieldType(java.lang.String fieldName)
getFieldType in class X3DConcreteElementfieldName - name of field in this X3D nodeConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPEpublic java.lang.String getAccessType(java.lang.String fieldName)
getAccessType in class X3DConcreteElementfieldName - name of field in this X3D nodeConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPEpublic final java.lang.String getContainerFieldDefault()
getContainerFieldDefault in class X3DConcreteNodepublic final void initialize()
initialize in class X3DConcreteNodepublic boolean getBottom()
public ConeObject setBottom(boolean newValue)
setBottom in interface ConenewValue - is new value for the bottom field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ConeObject setBottom(SFBoolObject newValue)
setBottom(boolean).newValue - is new value for the bottom field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public float getBottomRadius()
getBottomRadius in interface Conepublic ConeObject setBottomRadius(float newValue)
setBottomRadius in interface ConenewValue - is new value for the bottomRadius field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ConeObject setBottomRadius(SFFloatObject newValue)
setBottomRadius(float).newValue - is new value for the bottomRadius field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public float getHeight()
public ConeObject setHeight(float newValue)
setHeight in interface ConenewValue - is new value for the height field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ConeObject setHeight(SFFloatObject newValue)
setHeight(float).newValue - is new value for the height field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public X3DMetadataObject getMetadata()
getMetadata in interface X3DNodegetMetadata in interface ConegetMetadata in interface X3DGeometryNodegetMetadataProtoInstance(),
X3D Scene Authoring Hints: Metadata Nodespublic ConeObject setMetadata(X3DMetadataObject newValue)
setMetadata in interface X3DNodesetMetadata in interface ConesetMetadata in interface X3DGeometryNodesetMetadata in class X3DConcreteNodenewValue - is new value for the metadata field.ConeObject - 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 ConeObject clearMetadata()
ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public ConeObject setMetadata(ProtoInstanceObject newValue)
setMetadata in class X3DConcreteNodenewValue - is new value for the metadata field.ConeObject - 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 boolean getSide()
public ConeObject setSide(boolean newValue)
setSide in interface ConenewValue - is new value for the side field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ConeObject setSide(SFBoolObject newValue)
setSide(boolean).newValue - is new value for the side field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public boolean getSolid()
public ConeObject setSolid(boolean newValue)
setSolid in interface ConenewValue - is new value for the solid field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ConeObject setSolid(SFBoolObject newValue)
setSolid(boolean).newValue - is new value for the solid field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final ConeObject setDEF(java.lang.String newValue)
setDEF in interface X3DNodesetDEF in interface ConesetDEF in interface X3DGeometryNodesetDEF in class X3DConcreteNodenewValue - is new value for the DEF field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ConeObject setDEF(SFStringObject newValue)
setDEF(String).newValue - is new value for the DEF field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final ConeObject 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 X3DNodesetUSE in interface ConesetUSE in interface X3DGeometryNodesetUSE in class X3DConcreteNodenewValue - is new value for the USE field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ConeObject setUSE(SFStringObject newValue)
setUSE(String).newValue - is new value for the USE field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final ConeObject setCssClass(java.lang.String newValue)
setCssClass in interface X3DNodesetCssClass in interface ConesetCssClass in interface X3DGeometryNodesetCssClass in class X3DConcreteNodenewValue - is new value for the class field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ConeObject setCssClass(SFStringObject newValue)
setCssClass(String).newValue - is new value for the class field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ConeObject setIS(ISObject newValue)
setIS in class X3DConcreteNodenewValue - is new value for the description field.ConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ISObject getIS()
getIS in class X3DConcreteNodepublic ConeObject setUSE(ConeObject 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 definedConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ConeObject addComments(java.lang.String newComment)
addComments in class X3DConcreteElementnewComment - initial valueConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public ConeObject addComments(java.lang.String[] newComments)
addComments in class X3DConcreteElementnewComments - array of commentsConeObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public ConeObject addComments(CommentsBlock newCommentsBlock)
addComments in class X3DConcreteElementnewCommentsBlock - block of comments to addConeObject - 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 X3DConcreteElementindentLevel - 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 X3DConcreteElementindentLevel - 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 X3DConcreteElementindentLevel - 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 X3DConcreteElementnameValue - 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 X3DConcreteElementnameValue - 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 X3DConcreteElementDEFvalue - 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 X3DConcreteElementCopyright ©2005-2017 Web3D Consortium under an open-source license, free for any use. Feedback is welcome.