Castle Game Engine: X3DNodes

# Unit X3DNodes
Description | Uses | Classes, Interfaces, Objects and Records | Functions and Procedures | Types | Constants | Variables
## Description Nodes and other important bulding blocks of VRML/X3D (prototypes, routes and so on). This is the central unit for VRML/X3D processing, as VRML/X3D file is basically just a graph of nodes. We represent whole VRML/X3D file by it's root node. This is what we load, save and process in this unit. The chapter "Reading, writing, processing VRML scene graph" in the documentation on [http://castle-engine.sourceforge.net/vrml_engine_doc/output/xsl/html/chapter.scene_graph.html] is almost completely devoted to documenting the design of this single unit. Various uses of this unit: Nodes can be loaded or saved from the stream in a classic or XML encoding. For classic encoding we use a lexer in X3DLexer unit. For XML encoding, we use standard FPC DOM unit. Loading and saving of fields (in both encodings) is inside X3DFields unit. When reading VRML/X3D files, we generally do not change the VRML/X3D graph. So we're able to save exactly the same VRML/X3D graph back to another file. See also [http://castle-engine.sourceforge.net/vrml_engine_doc/output/xsl/html/section.writing_vrml.html#section.vrml_preserving]. This allows writing various VRML/X3D processing tools, that can simply read the file, change whatever they want, and write the file back — knowing that the "untouched" parts of graph are preserved perfectly. TX3DNode class offers a lot of methods to process VRML/X3D graph. See TX3DNode.Traverse, TX3DNode.EnumerateNodes and TX3DNode.FindNode. TX3DNode.Traverse is especially important, as it walks through VRML/X3D graph just as the specification says (accumulating transformation, visiting only active children of nodes like Switch or LOD), gathering some state (useful especially for VRML 1.0, but also used for various things in later VRML/X3D versions). When you want to render VRML/X3D graph, you can just traverse the graph and render each geometry node (TAbstractGeometryNode instance) knowing it's state (that will contain transformation and such). Alternatively, simple renderer can also use TAbstractGeometryNode.Triangulate. TAbstractGeometryNode is an important descendant of TX3DNode, as it defines stuff actually visible in the 3D world. It has useful routines for calculating bounding volumes, triangulating and such. But note that usually it's more comfortable to load your scene to TCastleScene or TCastleSceneCore and then query the shapes list in TCastleSceneCore.Shapes — this is usually more comfortable, also TCastleSceneCore and TShape cache some results for speed. This unit doesn't depend on OpenGL, or any other particular rendering method. So it's suitable also for CastleRayTracer, and every other possible renderer that will ever get implemented. Your own units can define new VRML/X3D nodes, by declaring new classes descending from TX3DNode (or other, more specialized, descendant). You should register your new classes by calling NodesManager.RegisterNodeClasses. Examples of defining your own VRML/X3D node types (without modifying sources of this unit, or any other unit) are for example in the X3DBezierCurve unit in `bezier_curves` demo, and LevelUnit in malfunction. Node class names, and inheritance: Normal VRML/X3D nodes are defined by classses named like `TXxxNode`. These nodes can be specified inside the VRML/X3D files. See VRML/X3D specifications, and also our extensions specification, on [http://castle-engine.sourceforge.net/vrml_x3d.php]. There are also abstract node classes. Their definitions are helpful for handling some functionality common to many descendants, and to declare allowed children in SFNode/MFNode fields. Abstract node classes are named like `TAbstractXxxNode`. Some of the abstract nodes are also defined by X3D specification, and some of them are just our own inventions. Finally, there are some special-purpose node classes that play important role in our VRML/X3D organization. They are not abstract, but also their exact instances are not created under normal circumstances. These are named like `TX3DXxxNode`, currently these are only: TX3DNode, TX3DRootNode, TX3DUnknownNode, TX3DPrototypeNode. All node classes descend from the base TX3DNode class. Some abstract nodes have also Pascal interfaces, like IAbstractXxxNode. Some ideas of X3D specification (although not many) need multiple inheritance, so interfaces have to be used. They all descend from IX3DNode. Optional suffix _1 or _2 at the node class name indicates that this is only for a specific VRML/X3D standard version. Suffix _1 indicates nodes specific to VRML 1.0. Suffix _2 indicates nodes specific to VRML 2.0 (aka 97), that are not available in X3D. Latest X3D nodes do not have any suffix (to not clutter the source code that simply wants to use the latest and best version of the standard). For example, we have TIndexedFaceSetNode_1 for VRML 1.0 and TIndexedFaceSetNode for VRML 2.0 and X3D. VRML/X3D versions handling: We handle VRML 1.0, VRML 2.0 (aka VRML 97) and X3D (aka VRML 3.x). Every correct VRML / X3D file in classic and XML encoding should be parsed by this unit. See [http://castle-engine.sourceforge.net/x3d_implementation_status.php] for much more detailed information about supported features. Also many Inventor 1.0 files are correctly parsed. We handle Inventor 1.0 mostly like VRML 1.0, also some small things and nodes specific for Inventor 1.0 are implemented here, see [http://castle-engine.sourceforge.net/x3d_extensions.php#ext_iv_in_vrml]. Note that structures in this unit are not focused on either VRML 1.0 or VRML >= 2.0. On the contrary: we try to handle the sum of all VRML and X3D. When reading VRML 1.0, many VRML 2.0 constructs (that do not conflict with anything in VRML 1.0) are allowed, and the other way around too. Internally, we do not convert VRML 1.0-specific constructs to VRML 2.0/X3D constructs (or the other way around). See [http://castle-engine.sourceforge.net/vrml_engine_doc/output/xsl/html/section.vrml_1_2_sum.html] for more in-depth explanation of how, and why, we handle both old-style (Inventor, VRML 1.0) and new-style (VRML 2.0, X3D) syntax. Files organization: X3D nodes are inside x3d_COMPONET_NAME.inc files. This way X3D specification components provide a natural way to group the vast number of nodes into files. Some remaining nodes that are not part of X3D are in other x3dnodes_xxx.inc files, for example x3dnodes_1.inc contains only VRML 1.0-specific nodes. ## Uses SysUtils FGL Classes XMLRead DOM CastleVectors X3DLexer CastleUtils CastleClassUtils X3DFields CastleBoxes CastleImages CastleColors CastleVideos X3DTime Castle3D CastleMaterialProperties CastleScript X3DCastleScript CastleOctree CastleDDS CastleTextureImages CastleKeysMouse CastleSoundEngine CastleStringUtils CastleTextureFontData CastleGenericLists CastleShaders CastleRays ## Overview ### Classes, Interfaces, Objects and Records
Name | Description
--- | ---
record `TTraverseStateLastNodes` | Nodes that will be saved inside TX3DGraphTraverseState.LastNodes.
Object `TLightInstance` | Light source instance in the scene.
Class `TLightInstancesList` |
record `TClipPlane` | Clipping plane, along with a transformation.
Class `TClipPlaneList` |
Class `TX3DGraphTraverseState` | Current state (transformation and such) when traversing VRML/X3D graph.
Class `TX3DGraphTraverseStateStack` | Stack of TX3DGraphTraverseState.
record `TTraversingInfo` |
Class `TNodeDestructionNotificationList` |
Class `TX3DNodesCache` | Cache for resources not specific to renderer (OpenGL).
Class `TX3DNodeDeepCopyState` | Private stuff for TX3DNode.DeepCopy and friends implementation.
Interface `IX3DNode` | X3D node interface.
Class `TX3DNode` | X3D node.
Class `TX3DNodeList` |
Class `TSFTextureUpdate` | Update field for rendered textures (like TGeneratedCubeMapTextureNode).
Class `TGeneratedTextureHandler` | Common interface for all VRML/X3D generated texture nodes.
Class `TX3DNodeClassesList` |
Class `TSFNode` | VRML/X3D field holding a reference to a single node.
Class `TMFNode` | VRML/X3D field holding a list of nodes.
Interface `IAbstractNode` |
Class `TAbstractNode` | Base X3D node.
Interface `IAbstractChildNode` |
Class `TAbstractChildNode` |
Class `TAbstractBindableNode` |
Class `TAbstractInfoNode` |
Interface `IAbstractMetadataObject` |
Interface `IAbstractSensorNode` | X3DSensorNode when it's a secondary ancestor.
Class `TAbstractSensorNode` |
Class `TMetadataBooleanNode` |
Class `TMetadataDoubleNode` |
Class `TMetadataFloatNode` |
Class `TMetadataIntegerNode` |
Class `TMetadataSetNode` |
Class `TMetadataStringNode` |
Class `TWorldInfoNode` |
Interface `IAbstractTimeDependentNode` |
Class `TTimeDependentNodeHandler` | Common helper for all X3DTimeDependentNode descendants.
Class `TAbstractTimeDependentNode` |
Class `TTimeSensorNode` |
Class `TAbstractGroupingNode` | This is a VRML/X3D >= 2.0 grouping node.
Interface `IAbstractBoundedObject` |
Class `TAbstractX3DGroupingNode` |
Class `TGroupNode` |
Class `TStringStringMap` |
Class `TX3DRootNode` | A top-level VRML/X3D node.
Class `TStaticGroupNode` |
Class `TSwitchNode` | Switch node.
Interface `ITransformNode` | Interface for all VRML 2.0 / X3D transformation nodes.
Class `TTransformNode` |
Class `TAbstractNetworkSensorNode` |
Interface `IAbstractUrlObject` |
Class `TAnchorNode` |
Class `TInlineNode` | Inline node.
Class `TInlineLoadControlNode` | InlineLoadControl (VRML 97 node).
Class `TLoadSensorNode` |
Class `ENotCoordinateBasedNode` |
Class `TAbstractGeometryNode` | Geometry nodes are the only nodes that produces some visible results during rendering.
Class `TAbstractGeometricPropertyNode` |
Class `TAbstractX3DGeometryNode` |
Class `TAbstractColorNode` |
Class `TAbstractComposedGeometryNode` |
Class `TAbstractCoordinateNode` |
Class `TAbstractNormalNode` |
Class `TClipPlaneNode` |
Class `TColorNode` |
Class `TColorRGBANode` |
Class `TCoordinateNode` |
Class `TIndexedLineSetNode` |
Class `TIndexedTriangleFanSetNode` |
Class `TIndexedTriangleSetNode` |
Class `TIndexedTriangleStripSetNode` |
Class `TLineSetNode` |
Class `TNormalNode` | Normal node.
Class `TPointSetNode` |
Class `TTriangleFanSetNode` |
Class `TTriangleSetNode` |
Class `TTriangleStripSetNode` |
Class `TAbstractAppearanceChildNode` |
Class `TAbstractAppearanceNode` |
Class `TAbstractMaterialNode` |
Class `TAbstractShapeNode` |
Class `TMFNodeShaders` |
Class `TAppearanceNode` |
Class `TFillPropertiesNode` |
Class `TLinePropertiesNode` |
Class `TMaterialNode` |
Class `TX3DMaterialInfoAbstract` | Material information, usable for all VRML/X3D versions.
Class `TX3DMaterialInfo` |
Class `TShapeNode` |
Class `TTwoSidedMaterialNode` |
Class `TBoxNode` |
Class `TConeNode` |
Class `TCylinderNode` |
Class `TElevationGridNode` |
Class `TExtrusionNode` |
Class `TIndexedFaceSetNode` |
Class `TSphereNode` |
Class `TArc2DNode` |
Class `TArcClose2DNode` |
Class `TCircle2DNode` |
Class `TDisk2DNode` |
Class `TPolyline2DNode` | Polyline2D node.
Class `TPolypoint2DNode` |
Class `TRectangle2DNode` |
Class `TTriangleSet2DNode` |
Class `TAbstractFontStyleNode` |
Class `TFontStyleNode` |
Class `TTextNode` |
Class `TAbstractSoundNode` |
Interface `IAbstractSoundSourceNode` |
Class `TAbstractSoundSourceNode` |
Class `TAudioClipNode` |
Class `TSoundNode` |
Class `TAbstractLightNode` | Base class for all VRML / X3D light nodes.
Class `TAbstractDirectionalLightNode` |
Class `TAbstractPositionalLightNode` |
Class `TAbstractPointLightNode` |
Class `TDirectionalLightNode` |
Class `TPointLightNode` |
Class `TSpotLightNode` |
Class `TAbstractTextureCoordinateNode` |
Class `TAbstractTextureNode` |
Class `TAbstractTexture2DNode` | VRML/X3D texture that is 2D and is loaded (from file or some other stream).
Class `TAbstractX3DTexture2DNode` |
Class `TAbstractTextureTransformNode` |
Class `TImageTextureNode` |
Class `TMovieTextureNode` |
Class `TMultiTextureNode` |
Class `TMultiTextureCoordinateNode` |
Class `TMultiTextureTransformNode` |
Class `TPixelTextureNode` |
Class `TTextureCoordinateNode` |
Class `TTextureCoordinateGeneratorNode` |
Class `TTextureCoordGenNode` | Old BS Contact name for TextureCoordinateGenerator.
Class `TTexturePropertiesNode` |
Class `TTextureTransformNode` |
Class `TAbstractInterpolatorNode` |
Class `TColorInterpolatorNode` |
Class `TColorSetInterpolatorNode` |
Class `TCoordinateInterpolatorNode` |
Class `TCoordinateInterpolator2DNode` |
Class `TEaseInEaseOutNode` |
Class `TNormalInterpolatorNode` |
Class `TOrientationInterpolatorNode` |
Class `TPositionInterpolatorNode` |
Class `TPositionInterpolator2DNode` |
Class `TScalarInterpolatorNode` |
Class `TSplinePositionInterpolatorNode` |
Class `TSplinePositionInterpolator2DNode` |
Class `TSplineScalarInterpolatorNode` |
Class `TSquadOrientationInterpolatorNode` |
Class `TVectorInterpolatorNode` |
Class `TCubicBezier2DOrientationInterpolatorNode` | Copyright 2002-2014 Michalis Kamburelis.
Class `TCubicBezierPositionInterpolatorNode` |
Class `TPointingDeviceSensorList` | List of pointing device sensors.
Class `TAbstractPointingDeviceSensorNode` |
Class `TAbstractDragSensorNode` |
Class `TAbstractTouchSensorNode` |
Class `TCylinderSensorNode` |
Class `TPlaneSensorNode` |
Class `TSphereSensorNode` |
Class `TTouchSensorNode` |
Class `TAbstractKeyDeviceSensorNode` |
Class `TKeySensorNode` |
Class `TStringSensorNode` |
Class `TAbstractEnvironmentalSensorNode` |
Class `TProximitySensorNode` |
Class `TTransformSensorNode` |
Class `TVisibilitySensorNode` |
Class `TAbstractViewpointNode` | Common ancestor for both VRML 1.0 camera nodes and VRML/X3D >= 2.0 viewpoint nodes.
Class `TAbstractX3DViewpointNode` |
Class `TBillboardNode` |
Class `TCollisionNode` |
Class `TAbstractLODNode` | LOD node for VRML/X3D >= 2.0.
Class `TLODNode_2` |
Class `TLODNode` |
Class `TNavigationInfoNode` |
Class `TOrthoViewpointNode` |
Class `TViewpointNode` |
Class `TViewpointGroupNode` |
Class `TAbstractBackgroundNode` |
Interface `IAbstractFogObject` |
Class `TBackgroundNode` |
Class `TFogNode` |
Class `TFogCoordinateNode` |
Class `TLocalFogNode` |
Class `TTextureBackgroundNode` |
Class `TGeoCoordinateNode` |
Class `TGeoElevationGridNode` |
Class `TGeoLocationNode` |
Class `TGeoLODNode` |
Class `TGeoMetadataNode` |
Class `TGeoOriginNode` |
Class `TGeoPositionInterpolatorNode` |
Class `TGeoProximitySensorNode` |
Class `TGeoTouchSensorNode` |
Class `TGeoTransformNode` |
Class `TGeoViewpointNode` |
Class `THAnimDisplacerNode` |
Object `TVertexJoints` |
Class `THAnimHumanoidNode` |
Class `THAnimJointNode` |
Class `THAnimSegmentNode` |
Class `THAnimSiteNode` |
Class `TAbstractNurbsControlCurveNode` |
Class `TAbstractParametricGeometryNode` |
Class `TAbstractNurbsSurfaceGeometryNode` |
Class `TContour2DNode` | Contour2D node for X3D.
Class `TContourPolyline2DNode` |
Class `TCoordinateDoubleNode` |
Class `TNurbsCurveNode` |
Class `TNurbsCurve2DNode` |
Class `TNurbsOrientationInterpolatorNode` |
Class `TNurbsPatchSurfaceNode` |
Class `TNurbsPositionInterpolatorNode` |
Class `TNurbsSetNode` |
Class `TNurbsSurfaceInterpolatorNode` |
Class `TNurbsSweptSurfaceNode` |
Class `TNurbsSwungSurfaceNode` |
Class `TNurbsTextureCoordinateNode` |
Class `TNurbsTrimmedSurfaceNode` |
Class `TDISEntityManagerNode` |
Class `TDISEntityTypeMappingNode` |
Class `TEspduTransformNode` |
Class `TReceiverPduNode` |
Class `TSignalPduNode` |
Class `TTransmitterPduNode` |
Class `TAbstractScriptNode` |
Class `TScriptNode` |
Class `TAbstractSequencerNode` |
Class `TAbstractTriggerNode` |
Class `TBooleanFilterNode` |
Class `TBooleanSequencerNode` |
Class `TBooleanToggleNode` |
Class `TBooleanTriggerNode` |
Class `TIntegerSequencerNode` |
Class `TIntegerTriggerNode` |
Class `TTimeTriggerNode` |
Class `TAbstractShaderNode` |
Class `TAbstractVertexAttributeNode` |
Interface `IAbstractProgrammableShaderObject` |
Class `TComposedShaderNode` |
Class `TFloatVertexAttributeNode` |
Class `TMatrix3VertexAttributeNode` |
Class `TMatrix4VertexAttributeNode` |
Class `TPackagedShaderNode` |
Class `TProgramShaderNode` |
Class `TShaderPartNode` |
Class `TShaderProgramNode` |
Interface `IAbstractX3DProductStructureChildNode` |
Class `TAbstractProductStructureChildNode` |
Class `TCADAssemblyNode` |
Class `TCADFaceNode` |
Class `TCADLayerNode` |
Class `TCADPartNode` |
Class `TIndexedQuadSetNode` |
Class `TQuadSetNode` |
Class `TAbstractTexture3DNode` |
Class `TComposedTexture3DNode` |
Class `TImageTexture3DNode` |
Class `TPixelTexture3DNode` |
Class `TTextureCoordinate3DNode` |
Class `TTextureCoordinate4DNode` |
Class `TTextureTransformMatrix3DNode` |
Class `TTextureTransform3DNode` |
Class `TAbstractEnvironmentTextureNode` |
Class `TComposedCubeMapTextureNode` |
Class `TGeneratedCubeMapTextureNode` |
Class `TImageCubeMapTextureNode` |
Class `TAbstractLayerNode` |
Class `TAbstractViewportNode` |
Class `TLayerNode` |
Class `TLayerSetNode` |
Class `TViewportNode` |
Class `TAbstractLayoutNode` |
Class `TLayoutNode` |
Class `TLayoutGroupNode` |
Class `TLayoutLayerNode` |
Class `TScreenFontStyleNode` |
Class `TScreenGroupNode` |
Class `TAbstractNBodyCollidableNode` |
Class `TAbstractNBodyCollisionSpaceNode` |
Class `TAbstractRigidJointNode` |
Class `TBallJointNode` |
Class `TCollidableOffsetNode` |
Class `TCollidableShapeNode` |
Class `TCollisionCollectionNode` |
Class `TCollisionSensorNode` |
Class `TCollisionSpaceNode` |
Class `TContactNode` |
Class `TDoubleAxisHingeJointNode` |
Class `TMotorJointNode` |
Class `TRigidBodyNode` |
Class `TRigidBodyCollectionNode` |
Class `TSingleAxisHingeJointNode` |
Class `TSliderJointNode` |
Class `TUniversalJointNode` |
Interface `IAbstractPickableObject` |
Class `TAbstractPickSensorNode` |
Class `TLinePickSensorNode` |
Class `TPickableGroupNode` |
Class `TPointPickSensorNode` |
Class `TPrimitivePickSensorNode` |
Class `TVolumePickSensorNode` |
Class `TAbstractFollowerNode` |
Class `TAbstractDamperNode` |
Class `TAbstractChaserNode` |
Class `TColorDamperNode` |
Class `TCoordinateDamperNode` |
Class `TOrientationChaserNode` |
Class `TOrientationDamperNode` |
Class `TPositionChaserNode` |
Class `TPositionChaser2DNode` |
Class `TPositionDamperNode` |
Class `TPositionDamper2DNode` |
Class `TScalarChaserNode` |
Class `TTexCoordDamper2DNode` |
Class `TAbstractParticleEmitterNode` |
Class `TAbstractParticlePhysicsModelNode` |
Class `TBoundedPhysicsModelNode` |
Class `TConeEmitterNode` |
Class `TExplosionEmitterNode` |
Class `TForcePhysicsModelNode` |
Class `TParticleSystemNode` |
Class `TPointEmitterNode` |
Class `TPolylineEmitterNode` |
Class `TSurfaceEmitterNode` |
Class `TVolumeEmitterNode` |
Class `TWindPhysicsModelNode` |
Class `TAbstractGeometryNode_1` | Geometry node allowed only in VRML <= 1.0.
Class `TAsciiTextNode_1` |
Class `TConeNode_1` |
Class `TCubeNode_1` |
Class `TCylinderNode_1` |
Class `TAbstractIndexedNode_1` | Common base class for VRML 1.0 indexed nodes (IndexedFaceSet, IndexedTriangleMesh, IndexedLineSet).
Class `TIndexedFacesOrTrianglesNode_1` | Common base class for VRML 1.0 indexed polygon nodes (IndexedFaceSet and IndexedTriangleMesh).
Class `TIndexedFaceSetNode_1` |
Class `TIndexedLineSetNode_1` |
Class `TPointSetNode_1` |
Class `TSphereNode_1` |
Class `TCoordinate3Node_1` |
Class `TFontStyleNode_1` |
Class `TInfoNode_1` |
Class `TLODNode_1` |
Class `TMaterialNode_1` |
Class `TX3DMaterialInfo_1` |
Class `TMaterialBindingNode_1` |
Class `TNormalBindingNode_1` |
Class `TTexture2Node_1` |
Class `TTexture2TransformNode_1` |
Class `TTextureCoordinate2Node_1` |
Class `TShapeHintsNode_1` |
Class `TAbstractTransformationNode_1` | Common base class for all nodes that modify the modelview matrix.
Class `TMatrixTransformNode_1` | VRML 1.0 MatrixTransform node.
Class `TRotationNode_1` |
Class `TScaleNode_1` |
Class `TTransformNode_1` |
Class `TTranslationNode_1` |
Class `TAbstractCameraNode_1` | Common base class for all cameras in VRML 1.0.
Class `TOrthographicCameraNode_1` |
Class `TPerspectiveCameraNode_1` |
Class `TDirectionalLightNode_1` |
Class `TPointLightNode_1` |
Class `TSpotLightNode_1` |
Class `TGroupNode_1` |
Class `TAbstractSeparatorNode_1` | Base class for VRML 1.0 nodes that push / pop all attributes and matrices.
Class `TSeparatorNode_1` |
Class `TSwitchNode_1` |
Class `TTransformSeparatorNode_1` |
Class `TWWWAnchorNode_1` |
Class `TWWWInlineNode_1` | VRML 1.0 WWWInline node.
Class `TIndexedTriangleMeshNode_1` | IndexedTriangleMesh (from Inventor 1.0).
Class `TRotationXYZNode` | RotationXYZ node (from Inventor).
Class `TDisplacerNode` |
Class `THumanoidNode` |
Class `TJointNode` |
Class `TSegmentNode` |
Class `TSiteNode` |
Class `TCoordinateDeformerNode` |
Class `TNurbsCurveNode_2` |
Class `TNurbsGroupNode` |
Class `TNurbsPositionInterpolatorNode_2` |
Class `TNurbsSurfaceNode` |
Class `TNurbsTextureSurfaceNode` |
Class `TTrimmedSurfaceNode` |
Class `TContour2DNode_2` |
Class `TKambiTriangulationNode` |
Class `TKambiHeadLightNode` |
Class `TText3DNode` |
Class `TBlendModeNode` | BlendMode node.
Class `TKambiAppearanceNode` |
Class `TKambiInlineNode` |
Class `TKambiNavigationInfoNode` |
Class `TKambiOctreePropertiesNode` |
Class `TGeneratedShadowMapNode` |
Class `TProjectedTextureCoordinateNode` |
Class `TScreenEffectNode` |
Class `TMultiGeneratedTextureCoordinateNode` | X3D MultiGeneratedTextureCoordinate node.
Class `TEffectNode` |
Class `TEffectPartNode` |
Class `TShaderTextureNode` |
Class `TMatrixTransformNode` | MatrixTransform node for VRML/X3D >= 2.0.
Class `TTeapotNode` |
Class `TLoggerNode` |
Class `TConverterNode` |
Class `TRenderedTextureNode` |
Class `TPlaneNode` |
Class `TTogglerNode` |
Class `TCircleNode` | Nodes that are defined by BitManagement (BS Contact) extensions.
Class `TLayer2DNode` |
Class `TLayer3DNode` |
Class `TMouseSensorNode` |
Class `TOrderedGroupNode` |
Class `TX3DUnknownNode` | Not recognized VRML/X3D node type.
Class `TX3DInterfaceDeclaration` | Interface declaration, used in VRML/X3D (exposed) prototypes and for nodes with dynamic fields (Script, ComposedShader).
Class `TX3DInterfaceDeclarationList` |
Class `EX3DPrototypeInstantiateError` |
Class `TX3DPrototypeNode` | Node with information about a VRML/X3D prototype.
Class `TX3DPrototypeBase` |
Class `TX3DPrototypeBaseList` |
Class `TX3DPrototype` |
Class `TX3DExternalPrototype` |
Class `TX3DRoute` |
Class `TX3DRouteList` |
Class `TX3DImport` |
Class `TX3DExport` |
Class `TX3DBindableStackBasic` |
Class `TX3DEventsEngine` | Abstract 3D object handling VRML/X3D events.
Class `TX3DEventsEngineList` |
Object `TX3DNodeNameRec` |
Class `TX3DNodeNames` | List to track node names while parsing VRML/X3D file.
Class `TX3DPrototypeNames` |
Class `TX3DImportableNames` |
Class `TX3DReaderNames` | Container tracking VRML/X3D node and prototype names during parsing.
Class `ENodesManagerError` |
Class `ENodeClassRegisterError` |
Class `TNodesManager` |
Class `TAbstractProductStructureChildNodeHelper` | Automatically generated X3D node class helpers.
Class `TCADAssemblyNodeHelper` |
Class `TCADFaceNodeHelper` |
Class `TCADLayerNodeHelper` |
Class `TCADPartNodeHelper` |
Class `TAbstractSensorNodeHelper` |
Class `TMetadataDoubleNodeHelper` |
Class `TMetadataFloatNodeHelper` |
Class `TMetadataIntegerNodeHelper` |
Class `TMetadataSetNodeHelper` |
Class `TMetadataStringNodeHelper` |
Class `TWorldInfoNodeHelper` |
Class `TGeneratedCubeMapTextureNodeHelper` |
Class `TDISEntityManagerNodeHelper` |
Class `TDISEntityTypeMappingNodeHelper` |
Class `TEspduTransformNodeHelper` |
Class `TReceiverPduNodeHelper` |
Class `TSignalPduNodeHelper` |
Class `TTransmitterPduNodeHelper` |
Class `TAbstractBackgroundNodeHelper` |
Class `TFogNodeHelper` |
Class `TLocalFogNodeHelper` |
Class `TAbstractEnvironmentalSensorNodeHelper` |
Class `TBooleanToggleNodeHelper` |
Class `TIntegerTriggerNodeHelper` |
Class `TAbstractChaserNodeHelper` |
Class `TAbstractDamperNodeHelper` |
Class `TColorDamperNodeHelper` |
Class `TOrientationChaserNodeHelper` |
Class `TOrientationDamperNodeHelper` |
Class `TPositionChaserNodeHelper` |
Class `TPositionChaser2DNodeHelper` |
Class `TPositionDamperNodeHelper` |
Class `TPositionDamper2DNodeHelper` |
Class `TScalarChaserNodeHelper` |
Class `TArc2DNodeHelper` |
Class `TArcClose2DNodeHelper` |
Class `TCircle2DNodeHelper` |
Class `TDisk2DNodeHelper` |
Class `TRectangle2DNodeHelper` |
Class `TBoxNodeHelper` |
Class `TConeNodeHelper` |
Class `TCylinderNodeHelper` |
Class `TElevationGridNodeHelper` |
Class `TExtrusionNodeHelper` |
Class `TIndexedFaceSetNodeHelper` |
Class `TSphereNodeHelper` |
Class `TGeoElevationGridNodeHelper` |
Class `TGeoLocationNodeHelper` |
Class `TGeoLODNodeHelper` |
Class `TGeoOriginNodeHelper` |
Class `TGeoProximitySensorNodeHelper` |
Class `TGeoTransformNodeHelper` |
Class `TGeoViewpointNodeHelper` |
Class `TAbstractX3DGroupingNodeHelper` |
Class `TStaticGroupNodeHelper` |
Class `TSwitchNodeHelper` |
Class `TTransformNodeHelper` |
Class `THAnimDisplacerNodeHelper` |
Class `THAnimHumanoidNodeHelper` |
Class `THAnimJointNodeHelper` |
Class `THAnimSegmentNodeHelper` |
Class `THAnimSiteNodeHelper` |
Class `TSplinePositionInterpolatorNodeHelper` |
Class `TSplinePositionInterpolator2DNodeHelper` |
Class `TSplineScalarInterpolatorNodeHelper` |
Class `TSquadOrientationInterpolatorNodeHelper` |
Class `TStringSensorNodeHelper` |
Class `TAbstractLayerNodeHelper` |
Class `TLayerSetNodeHelper` |
Class `TScreenFontStyleNodeHelper` |
Class `TAbstractLightNodeHelper` |
Class `TSpotLightNodeHelper` |
Class `TAbstractX3DViewpointNodeHelper` |
Class `TBillboardNodeHelper` |
Class `TCollisionNodeHelper` |
Class `TLODNodeHelper` |
Class `TNavigationInfoNodeHelper` |
Class `TOrthoViewpointNodeHelper` |
Class `TViewpointNodeHelper` |
Class `TViewpointGroupNodeHelper` |
Class `TAnchorNodeHelper` |
Class `TInlineNodeHelper` |
Class `TLoadSensorNodeHelper` |
Class `TAbstractNurbsSurfaceGeometryNodeHelper` |
Class `TNurbsCurveNodeHelper` |
Class `TNurbsCurve2DNodeHelper` |
Class `TNurbsOrientationInterpolatorNodeHelper` |
Class `TNurbsPositionInterpolatorNodeHelper` |
Class `TNurbsSetNodeHelper` |
Class `TNurbsSurfaceInterpolatorNodeHelper` |
Class `TNurbsTextureCoordinateNodeHelper` |
Class `TAbstractParticleEmitterNodeHelper` |
Class `TAbstractParticlePhysicsModelNodeHelper` |
Class `TConeEmitterNodeHelper` |
Class `TExplosionEmitterNodeHelper` |
Class `TParticleSystemNodeHelper` |
Class `TPointEmitterNodeHelper` |
Class `TPolylineEmitterNodeHelper` |
Class `TVolumeEmitterNodeHelper` |
Class `TWindPhysicsModelNodeHelper` |
Class `TPickableGroupNodeHelper` |
Class `TAbstractDragSensorNodeHelper` |
Class `TAbstractPointingDeviceSensorNodeHelper` |
Class `TCylinderSensorNodeHelper` |
Class `TPlaneSensorNodeHelper` |
Class `TSphereSensorNodeHelper` |
Class `TAbstractComposedGeometryNodeHelper` |
Class `TClipPlaneNodeHelper` |
Class `TIndexedLineSetNodeHelper` |
Class `TAbstractNBodyCollidableNodeHelper` |
Class `TAbstractNBodyCollisionSpaceNodeHelper` |
Class `TBallJointNodeHelper` |
Class `TCollisionCollectionNodeHelper` |
Class `TCollisionSpaceNodeHelper` |
Class `TContactNodeHelper` |
Class `TDoubleAxisHingeJointNodeHelper` |
Class `TMotorJointNodeHelper` |
Class `TRigidBodyNodeHelper` |
Class `TRigidBodyCollectionNodeHelper` |
Class `TSingleAxisHingeJointNodeHelper` |
Class `TSliderJointNodeHelper` |
Class `TUniversalJointNodeHelper` |
Class `TScriptNodeHelper` |
Class `TAbstractVertexAttributeNodeHelper` |
Class `TFloatVertexAttributeNodeHelper` |
Class `TAbstractShapeNodeHelper` |
Class `TFillPropertiesNodeHelper` |
Class `TLinePropertiesNodeHelper` |
Class `TMaterialNodeHelper` |
Class `TTwoSidedMaterialNodeHelper` |
Class `TAbstractSoundSourceNodeHelper` |
Class `TSoundNodeHelper` |
Class `TFontStyleNodeHelper` |
Class `TTextNodeHelper` |
Class `TAbstractTexture3DNodeHelper` |
Class `TTextureTransform3DNodeHelper` |
Class `TMovieTextureNodeHelper` |
Class `TMultiTextureNodeHelper` |
Class `TTextureCoordinateGeneratorNodeHelper` |
Class `TTexturePropertiesNodeHelper` |
Class `TTextureTransformNodeHelper` |
Class `TAbstractTimeDependentNodeHelper` |
Class `TTimeSensorNodeHelper` |
Class `TAppearanceNodeHelper` |
Class `TGeneratedShadowMapNodeHelper` |
Class `TText3DNodeHelper` |
Class `TKambiNavigationInfoNodeHelper` |
Class `TKambiTriangulationNodeHelper` |
Class `TKambiHeadLightNodeHelper` |
Class `TKambiOctreePropertiesNodeHelper` |
Class `TTeapotNodeHelper` |
Class `TRenderedTextureNodeHelper` |
Class `TLoggerNodeHelper` |
Class `TScreenEffectNodeHelper` |
Class `TEffectNodeHelper` |
### Functions and Procedures
`function LoadX3DClassic(Stream: TPeekCharStream; const BaseUrl: string): TX3DRootNode; overload;`
`function LoadX3DClassicFromString(const VRMLContents: string; const BaseUrl: string): TX3DRootNode; overload;`
`function LoadX3DClassic(const URL: string; const AllowStdIn: boolean; const Gzipped: boolean = false): TX3DRootNode; overload;`
`function LoadX3DXml(const URL: string; Gzipped: boolean): TX3DRootNode;`
`function LoadX3DXml(Stream: TStream; const URL: string): TX3DRootNode;`
`function Save3DVersion(Node: TX3DNode): TX3DVersion;`
`procedure Save3D(Node: TX3DNode; const Stream: TStream; const Generator, Source: string; Version: TX3DVersion; const Encoding: TX3DEncoding; const ForceConvertingToX3D: boolean = false); overload;`
`procedure Save3D(Node: TX3DNode; const URL, Generator, Source: string; const Version: TX3DVersion; const Encoding: TX3DEncoding; const ForceConvertingToX3D: boolean = false); overload;`
`procedure Save3D(Node: TX3DNode; const Stream: TStream; const Generator, Source: string; const Encoding: TX3DEncoding; const ForceConvertingToX3D: boolean = false); overload;`
`procedure Save3D(Node: TX3DNode; const URL, Generator, Source: string; const Encoding: TX3DEncoding; const ForceConvertingToX3D: boolean = false); overload;`
`function Save3DWillConvertToX3D(Version: TX3DVersion; const Encoding: TX3DEncoding; const ForceConvertingToX3D: boolean): boolean;`
`procedure TraverseState_CreateNodes(var StateNodes: TTraverseStateLastNodes);`
`procedure TraverseState_FreeAndNilNodes(var StateNodes: TTraverseStateLastNodes);`
`procedure X3DNodeList_FreeUnusedAndNil(var List: TX3DNodeList);`
`function KeyRange(Key: TSingleList; const Fraction: Single; out T: Single): Integer;`
`procedure FreeIfUnusedAndNil(var Obj);`
### Types
`TX3DNodeClass = class of TX3DNode;`
`TX3DNodeProc = procedure (node: TX3DNode) of object;`
`TVRML1StateNode = (...);`
`PLightInstance = ˆTLightInstance;`
`PClipPlane = ˆTClipPlane;`
`PTraversingInfo = ˆTTraversingInfo;`
`TTraversingFunc = procedure (Node: TX3DNode; StateStack: TX3DGraphTraverseStateStack; ParentInfo: PTraversingInfo; var TraverseIntoChildren: boolean) of object;`
`TTraversingAfterFunc = procedure (Node: TX3DNode; StateStack: TX3DGraphTraverseStateStack; ParentInfo: PTraversingInfo) of object;`
`TEnumerateChildrenFunction = procedure (Node, Child: TX3DNode) of object;`
`TEnumerateReplaceNodesFunction = procedure (ParentNode: TX3DNode; var Node: TX3DNode) of object;`
`TX3DAccessType = (...);`
`TX3DAccessTypes = set of TX3DAccessType;`
`TNodeDestructionNotification = procedure (Node: TX3DNode) of object;`
`TNodeTransformationChange = (...);`
`TCachedNodeList = specialize TFPGObjectList<TCachedNode>;`
`TTextureUpdate = (...);`
`TAllowedChildren = (...);`
`TTimeFunction = function: TFloatTime of object;`
`TGroupNode_2 = TGroupNode;`
`TStringLongIntMap = specialize TFPGMap<string, LongInt>;`
`TSwitchNode_2 = TSwitchNode;`
`TTransformNode_2 = TTransformNode;`
`TCoordRangeHandler = procedure (const RangeNumber: Cardinal; BeginIndex, EndIndex: Integer) of object;`
`TIndexedPolygonHandler = procedure (const Indexes: array of Cardinal) of object;`
`TIndexedLineSetNode_2 = TIndexedLineSetNode;`
`TPointSetNode_2 = TPointSetNode;`
`TShading = (...);`
`TMaterialNode_2 = TMaterialNode;`
`TConeNode_2 = TConeNode;`
`TCylinderNode_2 = TCylinderNode;`
`TIndexedFaceSetNode_2 = TIndexedFaceSetNode;`
`TSphereNode_2 = TSphereNode;`
`TX3DFontFamily = (...);`
`TX3DFontJustify = (...);`
`TFontStyleNode_2 = TFontStyleNode;`
`TLightScope = (...);`
`TDirectionalLightNode_2 = TDirectionalLightNode;`
`TPointLightNode_2 = TPointLightNode;`
`TSpotLightNode_2 = TSpotLightNode;`
`TX3DViewpointClassNode = class of TAbstractViewpointNode;`
`TLODNode_3 = TLODNode;`
`TOptionalBlendingSort = (...);`
`TBackgroundSide = (...);`
`TFogTypeOrNone = (...);`
`TFogType = ftLinear..ftExp;`
`PVertexJoints = ˆTVertexJoints;`
`TVertexJointsList = specialize TGenericStructList<TVertexJoints>;`
`TNurbsCurveNode_3 = TNurbsCurveNode;`
`TNurbsPositionInterpolatorNode_3 = TNurbsPositionInterpolatorNode;`
`TScriptType = (...);`
`TSceneOctreeProperties = (...);`
`TMatrixTransformNode_2 = TMatrixTransformNode;`
`PX3DNodeNameRec = ˆTX3DNodeNameRec;`
`TX3DVersion = X3DLexer.TX3DVersion;`
`TX3DEncoding = X3DLexer.TX3DEncoding;`
### Constants
`DefaultMaterial_1AmbientColor: TVector3Single = (0.2, 0.2, 0.2);`
`DefaultMaterialAmbientIntensity = 0.2;`
`DefaultMaterialDiffuseColor: TVector3Single = (0.8, 0.8, 0.8);`
`DefaultMaterialSpecularColor: TVector3Single = (0, 0, 0);`
`DefaultMaterialEmissiveColor: TVector3Single = (0, 0, 0);`
`DefaultMaterialShininess = 0.2;`
`DefaultMaterialTransparency = 0.0;`
`DefaultMaterialMirror = 0.0;`
`DefaultMaterialReflSpecularExp = 1000000;`
`DefaultMaterialTransSpecularExp = 1000000;`
`TraverseStateLastNodesClasses : array [TVRML1StateNode] of TX3DNodeClass = ( TCoordinate3Node_1, TShapeHintsNode_1, TFontStyleNode_1, TMaterialNode_1, TMaterialBindingNode_1, TNormalNode, TNormalBindingNode_1, TTexture2Node_1, TTextureCoordinate2Node_1, TKambiTriangulationNode );`
`LoadX3DClassic_FileFilters = 'All files|*|' + '*VRML (*.wrl, *.wrl.gz, *.wrz)|*.wrl;*.wrl.gz;*.wrz';`
`LoadX3DXml_FileFilters = 'All files|*|' + '*X3D XML (*.x3d, *.x3dz, *.x3d.gz)|*.x3d;*.x3dz;*.x3d.gz';`
`ProjectionTypeToStr: array [TProjectionType] of string = ('Orthographic', 'Perspective');`
`JUSTIFICATION_LEFT = 0;`
`JUSTIFICATION_CENTER = 1;`
`JUSTIFICATION_RIGHT = 2;`
`BIND_DEFAULT = 0;`
`BIND_OVERALL = 1;`
`BIND_PER_PART = 2;`
`BIND_PER_PART_INDEXED = 3;`
`BIND_PER_FACE = 4;`
`BIND_PER_FACE_INDEXED = 5;`
`BIND_PER_VERTEX = 6;`
`BIND_PER_VERTEX_INDEXED = 7;`
`VERTORDER_UNKNOWN = 0;`
`VERTORDER_CLOCKWISE = 1;`
`VERTORDER_COUNTERCLOCKWISE = 2;`
`SHTYPE_UNKNOWN = 0;`
`SHTYPE_SOLID = 1;`
`FACETYPE_UNKNOWN = 0;`
`FACETYPE_CONVEX = 1;`
`FSFAMILY_SERIF = 0;`
`FSFAMILY_SANS = 1;`
`FSFAMILY_TYPEWRITER = 2;`
`FSSTYLE_BOLD = 0;`
`FSSTYLE_ITALIC = 1;`
`CONE_PARTS_SIDES = 0;`
`CONE_PARTS_BOTTOM = 1;`
`CYLINDER_PARTS_SIDES = 0;`
`CYLINDER_PARTS_TOP = 1;`
`CYLINDER_PARTS_BOTTOM = 2;`
`TEXWRAP_REPEAT = 0;`
`TEXWRAP_CLAMP = 1;`
`DefaultHeightMapScale = 0.01;`
`DefaultVRML1CreaseAngle = 0.5;`
`DefaultViewpointFieldOfView = Pi / 4;`
`DefaultNavigationInfoHeadlight = true;`
`DefaultRenderedTextureWidth = 128;`
`DefaultRenderedTextureHeight = 128;`
`DefaultShadowMapScale = 1.1;`
`DefaultShadowMapBias = 4.0;`
`VRML1Version: TX3DVersion = (Major: 1; Minor: 0);`
`VRML2Version: TX3DVersion = (Major: 2; Minor: 0);`
`X3DVersion: TX3DVersion = (Major: 3; Minor: 2);`
`xeClassic = X3DLexer.xeClassic;`
`xeXML = X3DLexer.xeXML;`
`MinQuadricSlices: Cardinal = 3;`
`MinQuadricStacks: Cardinal = 1;`
`MinRectDivisions: Cardinal = 0;`
`URNVRML97Nodes = 'urn:web3d:vrml97:node:';`
`URNX3DNodes = 'urn:web3d:x3d:node:';`
`URNKambiNodes = 'urn:castle-engine.sourceforge.net:node:';`
`URNKambiNodes2 = 'urn:vrmlengine.sourceforge.net:node:';`
`URNBitManagementNodes = 'urn:inet:bitmanagement.de:node:';`
`DefaultAnimationPrefix = 'Animation_';`
`AllAccessTypes = [atInputOnly, atOutputOnly, atInitializeOnly, atInputOutput];`
`RestrictedAccessTypes = [atInputOnly, atOutputOnly, atInitializeOnly];`
### Variables
`NodesManager: TNodesManager;`
`WarnAboutAbsoluteFilenames: boolean = true;`
`Detail_QuadricSlices: Cardinal = 30;`
`Detail_QuadricStacks: Cardinal = 20;`
`Detail_RectDivisions: Cardinal = 2;`
`AnyNodeDestructionNotifications: TNodeDestructionNotificationList;`
`X3DCache: TX3DNodesCache;`
## Description ### Functions and Procedures
`function LoadX3DClassic(Stream: TPeekCharStream; const BaseUrl: string): TX3DRootNode; overload;`
Load VRML/X3D file in classic encoding from stream. Return it's root node. Note that you must pass here TPeekCharStream class, not just any generic TStream class. But it's not a problem, really, because you can wrap any class inside TPeekCharStream descendant. E.g. do
        LoadX3DClassic(TBufferedReadStream.Create(MyStream, false), BaseUrl)
Note that this function can't handle compressed data (VRML files are sometimes compressed with gzip). You should already pass here a stream with uncompressed text data. ###### Exceptions raised EX3DGzipCompressed If the Stream starts with gzip file header.
`function LoadX3DClassicFromString(const VRMLContents: string; const BaseUrl: string): TX3DRootNode; overload;`
`function LoadX3DClassic(const URL: string; const AllowStdIn: boolean; const Gzipped: boolean = false): TX3DRootNode; overload;`
Load VRML/X3D file in classic encoding, return it's root node. Automatically handles VRML/X3D files compressed with gzip, uncompressing them on the fly. URL without any protocol is treated as a filename (absolute or relative to current dir). We can also load network URLs using CastleDownload. If AllowStdIn then URL = '-' is understood as "standard input" (StdInStream). Base for resolving relative URLs in this case is the current working directory. If Gzipped then we can be relatively sure that stream is gzipped. Otherwise, it can still be gzipped (.wrl files are sometimes gzipped without extension indicating it).
`function LoadX3DXml(const URL: string; Gzipped: boolean): TX3DRootNode;`
Read X3D encoded in XML, and convert it to VRML/X3D nodes graph. Overloaded version that takes Stream as a parameter expects that reading the stream returns the uncompressed content (no longer gzip compressed). This version also takes URL as a parameter, but it is not used to load contents (these are inside Stream), it it only used to resolve relative URLs inside content and for error messages.
`function LoadX3DXml(Stream: TStream; const URL: string): TX3DRootNode;`
`function Save3DVersion(Node: TX3DNode): TX3DVersion;`
Which VRML/X3D version should be used to save this 3D model.
`procedure Save3D(Node: TX3DNode; const Stream: TStream; const Generator, Source: string; Version: TX3DVersion; const Encoding: TX3DEncoding; const ForceConvertingToX3D: boolean = false); overload;`
Write VRML/X3D model to a file. Generates a complete file, with header lines (XML headers, or #VRML / #X3D in classic encoding) and everything. Overloaded version that takes an URL will automatically compress the file with gzip if an extension indicating gzip compression is present (like .x3dv.gz, or .x3d.gz). Generator and Source, if not empty, will be used to set appropriate META values of X3D root file node. This way you can indicate inside X3D file the generator (your program) name and source (original 3D model file name). If this is not an X3D root file node, we will record it inside a comment. When ForceConvertingToX3D or when Encoding <> xeClassic, the node graph will be converted to X3D (if it isn't X3D already). This can be used to convert VRML 2.0 to X3D. For VRML 1.0 or Inventor, this will just save them in X3D (XML or classic) encoding, which is not really usable. We simply don't implement VRML 1.0/Inventor convertion (it's difficult, and not worth the trouble, VRML 1.0/Inventor are really old). Note that converting to X3D will change the nodes graph, possibly removing some nodes. If you use TCastleSceneCore, you should call TCastleSceneCore.BeforeNodesFree before and TCastleSceneCore.ChangedAll when such convertion occcurs (you can easily test whether it may happen by Save3DWillConvertToX3D). If you use Encoding=xeClassic and ForceConvertingToX3D=false, you're safe: convertion will not happen. ###### Parameters Version Which VRML/X3D specification version should be used to encode. It should be calculated by Save3DVersion(Node). You often want to calculate it yourself, before calling Save3D, this way you can propose a sensible saved model extension for user (.wrl for VRML <= 2.0 in classic encoding, .x3dv for X3D in classic encoding). Note that this parameter is not a mechanism to convert between various VRML/X3D versions. This procedure does not convert VRML/X3D nodes/fields inside. For example, you can't just change Version.Major value from 1 to 3 to convert VRML 1.0 to X3D. It would cause some information to be encoded in X3D style (e.g. generated file will have X3D header and PROFILE information), but the nodes would stil have VRML 1.0 names and fields. Which means that you would not generate correct X3D file. So this should really be calculated based on model contents, usually by Save3DVersion(Node). A limited VRML 2.0 convertion is possible by ForceConvertingToX3D = true. In this case, Version will be automatically changed to X3D anyway.
`procedure Save3D(Node: TX3DNode; const URL, Generator, Source: string; const Version: TX3DVersion; const Encoding: TX3DEncoding; const ForceConvertingToX3D: boolean = false); overload;`
`procedure Save3D(Node: TX3DNode; const Stream: TStream; const Generator, Source: string; const Encoding: TX3DEncoding; const ForceConvertingToX3D: boolean = false); overload;`
`procedure Save3D(Node: TX3DNode; const URL, Generator, Source: string; const Encoding: TX3DEncoding; const ForceConvertingToX3D: boolean = false); overload;`
`function Save3DWillConvertToX3D(Version: TX3DVersion; const Encoding: TX3DEncoding; const ForceConvertingToX3D: boolean): boolean;`
`procedure TraverseState_CreateNodes(var StateNodes: TTraverseStateLastNodes);`
Create and assign all State.Nodes.
`procedure TraverseState_FreeAndNilNodes(var StateNodes: TTraverseStateLastNodes);`
Free and nil all State.Nodes.
`procedure X3DNodeList_FreeUnusedAndNil(var List: TX3DNodeList);`
Free all unused VRML/X3D nodes on the list, then free and `Nil` the list itself.
`function KeyRange(Key: TSingleList; const Fraction: Single; out T: Single): Integer;`
Find a range within "key" field corresponding to given Fraction. Returns the index of right range delimiter. So for normal ranges (between two values of "key" field) it's always between 1 and FdKey.Count - 1. Result 0 indicates we're before the left limit, and result equal FdKey.Count indicates we're after right limit. Result is always between 0 and FdKey.Count. Output T is the value between 0..1 indicating where within the range we are. It's undefined when Result is 0 or Key.Count (indicating we're outside limits). Call this only when FdKey.Count > 0. This is useful to interpreting TAbstractInterpolatorNode.KeyRange and such fields.
`procedure FreeIfUnusedAndNil(var Obj);`
Free TX3DNode if it is unused (see TX3DNode.FreeIfUnused), setting reference to `Nil`. Analogous to standard FreeAndNil, but checks if node is used first.
### Types
`TX3DNodeClass = class of TX3DNode;`
`TX3DNodeProc = procedure (node: TX3DNode) of object;`
`TVRML1StateNode = (...);`
###### Values vsCoordinate3: vsShapeHints: vsFontStyle: vsMaterial: vsMaterialBinding: vsNormal: vsNormalBinding: vsTexture2: vsTextureCoordinate2: vsKambiTriangulation:
`PLightInstance = ˆTLightInstance;`
`PClipPlane = ˆTClipPlane;`
`PTraversingInfo = ˆTTraversingInfo;`
`TTraversingFunc = procedure (Node: TX3DNode; StateStack: TX3DGraphTraverseStateStack; ParentInfo: PTraversingInfo; var TraverseIntoChildren: boolean) of object;`
Used as a callback by TX3DNode.Traverse.
`TTraversingAfterFunc = procedure (Node: TX3DNode; StateStack: TX3DGraphTraverseStateStack; ParentInfo: PTraversingInfo) of object;`
`TEnumerateChildrenFunction = procedure (Node, Child: TX3DNode) of object;`
`TEnumerateReplaceNodesFunction = procedure (ParentNode: TX3DNode; var Node: TX3DNode) of object;`
`TX3DAccessType = (...);`
###### Values atInputOnly: atOutputOnly: atInitializeOnly: atInputOutput:
`TX3DAccessTypes = set of TX3DAccessType;`
`TNodeDestructionNotification = procedure (Node: TX3DNode) of object;`
`TNodeTransformationChange = (...);`
###### Values ntcNone: ntcSwitch: TSwitchNode ntcLOD: TAbstractLODNode ntcTransform: ITransformNode ntcGeometry: TAbstractGeometryNode ntcBackground: TAbstractBackgroundNode ntcFog: TFogNode ntcViewpoint: TAbstractViewpointNode ntcLight: TAbstractLightNode ntcProximitySensor: TProximitySensorNode ntcVisibilitySensor: TVisibilitySensorNode
`TCachedNodeList = specialize TFPGObjectList<TCachedNode>;`
`TTextureUpdate = (...);`
Possible update modes for generated textures (like TGeneratedCubeMapTextureNode). ###### Values upNone: upNextFrameOnly: upAlways:
`TAllowedChildren = (...);`
###### Values acAll: acClasses: acInterface:
`TTimeFunction = function: TFloatTime of object;`
`TGroupNode_2 = TGroupNode;`
`TStringLongIntMap = specialize TFPGMap<string, LongInt>;`
`TSwitchNode_2 = TSwitchNode;`
`TTransformNode_2 = TTransformNode;`
`TCoordRangeHandler = procedure (const RangeNumber: Cardinal; BeginIndex, EndIndex: Integer) of object;`
`TIndexedPolygonHandler = procedure (const Indexes: array of Cardinal) of object;`
`TIndexedLineSetNode_2 = TIndexedLineSetNode;`
`TPointSetNode_2 = TPointSetNode;`
`TShading = (...);`
###### Values shDefault: shPhong:
`TMaterialNode_2 = TMaterialNode;`
`TConeNode_2 = TConeNode;`
`TCylinderNode_2 = TCylinderNode;`
`TIndexedFaceSetNode_2 = TIndexedFaceSetNode;`
`TSphereNode_2 = TSphereNode;`
`TX3DFontFamily = (...);`
Font family that can be specified by a TFontStyleNode. ###### Values ffSerif: ffSans: ffTypeWriter:
`TX3DFontJustify = (...);`
Font justification that can be specified by a TFontStyleNode. ###### Values fjFirst: fjBegin: fjMiddle: fjEnd:
`TFontStyleNode_2 = TFontStyleNode;`
`TLightScope = (...);`
###### Values lsGlobal: Light shines everywhere. VRML/X3D >= 2 calls these lights global. lsLocal: Light shines only within it's VRML/X3D grouping node. VRML/X3D >= 2 calls these lights not global. lsLocalVRML1: Light shines only on the following shapes within it's VRML/X3D grouping node. This is used by VRML 1.0 (and Inventor) light sources.
`TDirectionalLightNode_2 = TDirectionalLightNode;`
`TPointLightNode_2 = TPointLightNode;`
`TSpotLightNode_2 = TSpotLightNode;`
`TX3DViewpointClassNode = class of TAbstractViewpointNode;`
`TLODNode_3 = TLODNode;`
`TOptionalBlendingSort = (...);`
###### Values obsDefault: obsNone: obs2D: obs3D:
`TBackgroundSide = (...);`
###### Values bsBack: bsBottom: bsFront: bsLeft: bsRight: bsTop:
`TFogTypeOrNone = (...);`
###### Values ftLinear: ftExp: ftNone:
`TFogType = ftLinear..ftExp;`
`PVertexJoints = ˆTVertexJoints;`
`TVertexJointsList = specialize TGenericStructList<TVertexJoints>;`
`TNurbsCurveNode_3 = TNurbsCurveNode;`
`TNurbsPositionInterpolatorNode_3 = TNurbsPositionInterpolatorNode;`
`TScriptType = (...);`
###### Values stCompiled: stCastleScript:
`TSceneOctreeProperties = (...);`
###### Values opRendering: opDynamicCollisions: opVisibleTriangles: opCollidableTriangles:
`TMatrixTransformNode_2 = TMatrixTransformNode;`
`PX3DNodeNameRec = ˆTX3DNodeNameRec;`
`TX3DVersion = X3DLexer.TX3DVersion;`
`TX3DEncoding = X3DLexer.TX3DEncoding;`
### Constants
`DefaultMaterial_1AmbientColor: TVector3Single = (0.2, 0.2, 0.2);`
`DefaultMaterialAmbientIntensity = 0.2;`
`DefaultMaterialDiffuseColor: TVector3Single = (0.8, 0.8, 0.8);`
`DefaultMaterialSpecularColor: TVector3Single = (0, 0, 0);`
`DefaultMaterialEmissiveColor: TVector3Single = (0, 0, 0);`
`DefaultMaterialShininess = 0.2;`
`DefaultMaterialTransparency = 0.0;`
`DefaultMaterialMirror = 0.0;`
`DefaultMaterialReflSpecularExp = 1000000;`
`DefaultMaterialTransSpecularExp = 1000000;`
`TraverseStateLastNodesClasses : array [TVRML1StateNode] of TX3DNodeClass = ( TCoordinate3Node_1, TShapeHintsNode_1, TFontStyleNode_1, TMaterialNode_1, TMaterialBindingNode_1, TNormalNode, TNormalBindingNode_1, TTexture2Node_1, TTextureCoordinate2Node_1, TKambiTriangulationNode );`
Classes corresponding to nodes on TTraverseStateLastNodes.
`LoadX3DClassic_FileFilters = 'All files|*|' + '*VRML (*.wrl, *.wrl.gz, *.wrz)|*.wrl;*.wrl.gz;*.wrz';`
File filters if you want to open a file and then pass it to LoadX3DClassic. Suitable for TCastleWindowCustom.FileDialog and such.
`LoadX3DXml_FileFilters = 'All files|*|' + '*X3D XML (*.x3d, *.x3dz, *.x3d.gz)|*.x3d;*.x3dz;*.x3d.gz';`
Global routines for parsing XML X3D encoding.
`ProjectionTypeToStr: array [TProjectionType] of string = ('Orthographic', 'Perspective');`
`JUSTIFICATION_LEFT = 0;`
Constants for TAsciiTextNode.FdJustification.Value.
`JUSTIFICATION_CENTER = 1;`
`JUSTIFICATION_RIGHT = 2;`
`BIND_DEFAULT = 0;`
Constants for TMaterialBindingNode_1.FdValue.Value and TNormalBindingNode_1.FdValue.Value.
`BIND_OVERALL = 1;`
`BIND_PER_PART = 2;`
`BIND_PER_PART_INDEXED = 3;`
`BIND_PER_FACE = 4;`
`BIND_PER_FACE_INDEXED = 5;`
`BIND_PER_VERTEX = 6;`
`BIND_PER_VERTEX_INDEXED = 7;`
`VERTORDER_UNKNOWN = 0;`
Constants for TShapeHintsNode_1.FdVertexOrdering.Value.
`VERTORDER_CLOCKWISE = 1;`
`VERTORDER_COUNTERCLOCKWISE = 2;`
`SHTYPE_UNKNOWN = 0;`
Constants for TShapeHintsNode_1.FdShapeType.Value.
`SHTYPE_SOLID = 1;`
`FACETYPE_UNKNOWN = 0;`
Constants for TShapeHintsNode_1.FdFaceType.Value.
`FACETYPE_CONVEX = 1;`
`FSFAMILY_SERIF = 0;`
Constants for TFontStyleNode.FdFamily.Value.
`FSFAMILY_SANS = 1;`
`FSFAMILY_TYPEWRITER = 2;`
`FSSTYLE_BOLD = 0;`
Constants for TFontStyleNode.FdStyleFlags.
`FSSTYLE_ITALIC = 1;`
`CONE_PARTS_SIDES = 0;`
Constants for TConeNode.FdParts.Flags.
`CONE_PARTS_BOTTOM = 1;`
`CYLINDER_PARTS_SIDES = 0;`
Constants for TCylinderNode.FdParts.Flags.
`CYLINDER_PARTS_TOP = 1;`
`CYLINDER_PARTS_BOTTOM = 2;`
`TEXWRAP_REPEAT = 0;`
Constants for TTexture2Node_1.FdWrapS.Value and TTexture2Node_1.FdWrapT.Value.
`TEXWRAP_CLAMP = 1;`
`DefaultHeightMapScale = 0.01;`
`DefaultVRML1CreaseAngle = 0.5;`
`DefaultViewpointFieldOfView = Pi / 4;`
`DefaultNavigationInfoHeadlight = true;`
`DefaultRenderedTextureWidth = 128;`
`DefaultRenderedTextureHeight = 128;`
`DefaultShadowMapScale = 1.1;`
`DefaultShadowMapBias = 4.0;`
`VRML1Version: TX3DVersion = (Major: 1; Minor: 0);`
`VRML2Version: TX3DVersion = (Major: 2; Minor: 0);`
`X3DVersion: TX3DVersion = (Major: 3; Minor: 2);`
Latest X3D version supported.
`xeClassic = X3DLexer.xeClassic;`
`xeXML = X3DLexer.xeXML;`
`MinQuadricSlices: Cardinal = 3;`
Minimal values for Detail_QuadricSlices, Detail_QuadricStacks, Detail_RectDivisions. Note that `MinQuadricSlices` can be lower (2), it works, but the result isn't really sensible.
`MinQuadricStacks: Cardinal = 1;`
`MinRectDivisions: Cardinal = 0;`
`URNVRML97Nodes = 'urn:web3d:vrml97:node:';`
URNs used to indicate standard VRML / X3D nodes. Funny thing, I actually didn't found anywhere a definite official statement that they are using such-and-such URNs. X3D specification refers to RFC [http://www.ietf.org/rfc/rfc3541.txt?number=3541] which, basically, just says "we like URNs and we'll use them" and nothing more. Same thing for VRML 97 spec [http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/extensions.html]. There is no precise answer e.g. what URN should be used to Indicate some standard VRML 97 / X3D node. I constructed URNs below looking at examples in the RFC, annotated by a funny line "The following examples are not guaranteed to be real. They are presented for pedagogical reasons only."
`URNX3DNodes = 'urn:web3d:x3d:node:';`
`URNKambiNodes = 'urn:castle-engine.sourceforge.net:node:';`
URN used to indicate VRML / X3D nodes that are Castle Game Engine extensions.
`URNKambiNodes2 = 'urn:vrmlengine.sourceforge.net:node:';`
`URNBitManagementNodes = 'urn:inet:bitmanagement.de:node:';`
URN to indicate BitManagement nodes. This should work, according to http://www.bitmanagement.com/developer/contact/examples/layer/index.html example EXTERNPROTO.
`DefaultAnimationPrefix = 'Animation_';`
Standard prefix name for a time sensor to be recognized as a "named animation" for TCastleSceneCore.PlayAnimation and friends.
`AllAccessTypes = [atInputOnly, atOutputOnly, atInitializeOnly, atInputOutput];`
`RestrictedAccessTypes = [atInputOnly, atOutputOnly, atInitializeOnly];`
### Variables
`NodesManager: TNodesManager;`
Nodes manager instance. In normal circumstances, this is the only instance of TNodesManager class ever created. It is created / destroyed in this unit's initialization / finalization.
`WarnAboutAbsoluteFilenames: boolean = true;`
Should be make a warning (using OnWarning) when loading data from an URI with absolute path. This is quite useful if you want to be able to move/copy the files to some other system/location, as absolute paths prevent it.
`Detail_QuadricSlices: Cardinal = 30;`
Quadric triangulation settings. Slices divide the circumference of the circle, like a slices of pizza. Stacks divide the height of the object, like stacks of a cake or tower. The precise meaning of slices and stacks parameters follows exactly the OpenGL Utility (GLU) functions (although our implementation doesn't use GLU). Note that the cylinder, cone, sphere and disk slices must match, otherwise artifacts will appear when you try to connect a sphere with a cylinder cap. Stacks and RectDivisions do not really have to match, but still it's sensible. Rectangles (used for Cube sides) are also subdivided, for better Gouraud shading. We use Detail_RectDivisions + 1 columns and rows, so we render `(Detail_RectDivisions + 1)ˆ2` quads for each cube side. For now, you can change these variables only before using anything from this module. If you want to change them inside VRML/X3D file (for example, to affect only part of the scene), use the KambiTriangulation node, see [http://castle-engine.sourceforge.net/x3d_extensions.php#section_ext_kambi_triangulation]. These variables must always honour MinQuadricSlices, MinQuadricStacks, MinRectDivisions limit.
`Detail_QuadricStacks: Cardinal = 20;`
`Detail_RectDivisions: Cardinal = 2;`
`AnyNodeDestructionNotifications: TNodeDestructionNotificationList;`
Functions registered here will be called when any TX3DNode descendant will be destroyed.
`X3DCache: TX3DNodesCache;`
Cache, for all the resources not tied with renderer context.
Generated by PasDoc 0.13.0 on 2015-06-15 04:43:14