Class TCommonSurfaceShaderNode

This item has no description.

Source: scene/x3d/castlefields_x3dfileitem.inc (line 42).

Save to stream.

Source: scene/x3d/castlefields_x3dfileitem.inc (line 75).

How is this saved to X3D XML encoding. This determines when SaveToStream is called. It also cooperates with some SaveToStream implementations, guiding how the item is actually saved. By default it is sxChildElement.

Source: scene/x3d/castlefields_x3dfileitem.inc (line 81).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 339).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 340).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 341).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 348).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 349).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 350).

Search by name for given field. When RaiseOnError=false (default) returns Nil when not found. When RaiseOnError=true raises EX3DNotFound when not found.

Exceptions raised

EX3DNotFound

Source: scene/x3d/x3dnodes_x3dnode.inc (line 357).

Search by name for given field or event (exposed by some field or not). When RaiseOnError=false (default) returns Nil when not found. When RaiseOnError=true raises EX3DNotFound when not found.

Exceptions raised

EX3DNotFound

Source: scene/x3d/x3dnodes_x3dnode.inc (line 363).

Search by name for given event (exposed by some field or not). When RaiseOnError=false (default) returns Nil when not found. When RaiseOnError=true raises EX3DNotFound when not found.

Exceptions raised

EX3DNotFound

Source: scene/x3d/x3dnodes_x3dnode.inc (line 369).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 410).

Add a VRML 1.0 child node at given position. Index (position) must be in [0..VRML1ChildrenCount]. Items at and above Index position are moved to the right, to insert new child at Index position.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 417).

Add a VRML 1.0 child node at the end of VRML1Children list.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 420).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 422).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 423).

Remove a VRML 1.0 children at index I and return it (do not free it). Compare this with VRML1Remove, that removes children I and frees it if it's no longer used by anything.

This removes children I, appropriately adjusting all parent / children links, but even if a node is unused after removing, it is not freed. It's always returned.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 432).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 440).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 455).

Free this object (if it's not Nil) also removing it from all parent nodes and fields.

By design, normal destructor (Destroy called by Free) doesn't care about removing references to this object from it's parents. That's because it's the parents that usually initialize freeing of their children, and they free child when it's reference count is 0. So this freeing method is special in this regard.

Use this if you really want to remove all node occurrences from the middle of VRML hierarchy.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 470).

Free this node if it is not referenced by any parent fields or nodes. Takes into account that node may have VRML 1.0 parent nodes and VRML 2.0 / X3D parent fields (SFNode or MFNode). This is a safe way of removing a node that may, but doesn't have to, be part of some VRML/X3D graph. The idea is that if a node is a part of some graph, we don't need to do anything (since you should have a reference to the entine graph somewhere anyway), otherwise node is considered unused and freed.

Analogous to standard TObject.Free, this also works when called on a Nil value (does nothing in this case).

For safety, it's advised to set reference to Nil after calling FreeIfUnused. You can use FreeIfUnusedAndNil utility for this (that employs a trick to Nil the visible reference even before freeing, which is even safer). This is analogous to standard FreeAndNil.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 489).

Increase "fake reference count" by 1, preventing the node from being automatically freed when the reference count changes from non-zero to zero.

It is discouraged to use this method. In most cases, TX3DNode.WaitForRelease and NodeRelease are easier to use than KeepExistingBegin + KeepExistingEnd + FreeIfUnusedAndNil.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 514).

Decrease "fake reference count" by 1. This should match previous KeepExistingBegin call. When nothing will refer to this node, and the "fake reference count" is zero, the node will be freed.

Note that merely calling KeepExistingEnd will not free the node. Follow this with FreeIfUnused or (better) FreeIfUnusedAndNil to actually free unused node.

It is discouraged to use this method. In most cases, TX3DNode.WaitForRelease and NodeRelease are easier to use than KeepExistingBegin + KeepExistingEnd + FreeIfUnusedAndNil.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 528).

Do not free this node, even if it will become unused. You must call NodeRelease to free this node.

By default, if this method was not used, every X3D node is reference-counted. This means that when the node starts being referenced by some other node (e.g. TAbstractShapeNode.Geometry refers to TIndexedFaceSetNode instance), the reference count is increased. When the node stops being referenced (e.g. TAbstractShapeNode.Geometry is set to Nil), the reference count is decreased. When the reference count reaches zero, the node is freed.

Calling this routine pauses this "automatic freeing" of the node.

Calling this rouine multiple times on the same node has no effect. So you don't need to pair every WaitForRelease call with NodeRelease, it's enough to call NodeRelease once, no matter how many times you called WaitForRelease on the same node.

The reference count is still increased and decreased, but we also keep additional "fake" reference to the node, so it will not be freed.

This should be always paired with NodeRelease, that will remove this "fake" reference and free the node (if it is unused).

See the https://castle-engine.io/shaders#node_release for an example of this.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 557).

Is node unused, looking at all mechanisms (VRML 1.0 parents, X3D parents, KeepExistingBegin/End, WaitsForRelease).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 561).

Returns an absolute path, assuming that RelativePath is relative path from BaseUrl or that RelativePath is already absolute.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 602).

Parse node. This should set values of your fields, VRML 1.0 Children list, BaseUrl.

In special cases like TX3DUnknownNode this may actually initialize whole Fields list (by VRML 1.0 "fields" extensibility feature).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 610).

Parse node body, i.e. mainly node's fields.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 613).

Constructor. Initializes various properties:

• Name, BaseUrl are initialized from given parameters.

• The Fields, Events lists are filled in every descendant, to have all the fields/events defined by the specification.

• DefaultContainerField, and other node-specific stuff, is filled in descendants. This is actually implemented in CreateNode, that is called at the end of this constructor.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 627).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 630).

Type of the node in X3D, like 'Group' or 'Shape'. Never empty. Constant for the class lifetime (even for special TX3DUnknownNode and TX3DPrototypeNode, where this is calculated at runtime).

Note that VRML/X3D is generally case-sensitive, so this property is too.

In TX3DNode, this returns ClassX3DType, which is suitable for most nodes. See ClassX3DType.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 641).

Warning: this symbol is deprecated: use X3DType

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 642).

Node type name in VRML/X3D, for this class. Normal VRML/X3D node classes should override this to return something non-empty, and then X3DType automatically will return the same value.

Empty for classes that don't have a hardcoded VRML/X3D node name, like a special TX3DUnknownNode. Such special classes should override then X3DType to return actual non-empty name there.

You usually should call X3DType. The only use of this method is that it works on classes (it's "class function"), without needing at actual instance.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 655).

Traverse all the nodes of VRML graph that are active.

An "active" part of the VRML graph are the nodes that actually change what the VRML file represents, in terms of geometry, collision detection etc. For example, the Switch node has only one child usually active. Nodes that merely influence the active graph by some events and routes do not have to be active (these nodes may change what the VRML file actually represents, but only by changing other nodes).

For all nodes of NodeClass TraversingFunc will be called. If if returns non-nil for some node, the processing of following nodes (children and siblings) will be aborted and result will be returned.

Traverse not only enumerates these nodes, it also collects all state (transformation, etc — see TX3DGraphTraverseState) that affects how given node should be presented.

Also, TraversingInfo is passed to each TraversingFunc call. This allows you to investigate, during TraversingFunc call, the parents hierarchy (you can't use VRML1Parents / ParentFields of the current node, since a node may have many parents). Traverse calls are naturally recursive, and so the stack of TraversingInfo structures is naturally build and destroyed by recursive calls. For the root node (the one where you called Traverse without specifying initial TraversingInfo), ParentInfo is simply Nil.

The scheme of how Traverse works:

BeforeTraverse;

TraverseIntoChildren := true;
if Self is NodeClass then TraversingFunc (Self, State, TraverseIntoChildren);

MiddleTraverse;

if TraverseIntoChildren is still true then
  for all children returned by DirectEnumerateActive
    call their Traverse(State);

AfterTraverse;

Add Self to State.VRML1State (for VRML 1.0 state nodes);

Note: setting TraverseIntoChildren to false means that some part of the tree is explicitly omitted from traversing. Use this only if you know what you're doing, as for some nodes they actually affect their parents too (for example, chilren within VRML 1.0 Group affect other nodes too; global lights within VRML >= 2.0 affect all nodes; and so on...). Usually, you will use this only for separator-like nodes (for VRML >= 2.0, all Group, Transform, Switch etc. act like separators), and only when you will somehow traverse into these nodes anyway.

We guarantee that AfterTraverse will be called if BeforeTraverse was called and finished (that is, AfterTraverse is called in the finally..end).

During traversing, you can only modify the children (direct or not) nodes of the current node.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 721).

Like Traverse, but it takes explicit starting state stack and starting ParentInfo. Not generally useful, use only for special purposes.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 728).

Like Traverse, but only enters children. This does the job of Traverse normally omitted if your Traverse callback returns TraverseIntoChildren = False. Using this method, you can traverse into children explicitly from your callback.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 738).

Enumerate all our children of some class. Recursively. Enumerates also this instance (Self), if it satisfies the NodeClass and SeekNodeName conditions.

This enumerates both VRML 1.0 children (VRML1Children) as well as VRML >= 2.0 (including X3D) children (nodes in TSFNode and TMFNode fields).

If OnlyActive then it will enumerate only active parts of the graph ("active" as defined by Traverse), so it will work as a simpler version of Traverse (simpler, because it doesn't track any state).

If not OnlyActive then it will simply enumerate all nodes. This will include then also prototype helpers, if this node was expanded from prototype: see PrototypeInstanceSourceNode and PrototypeInstanceHelpers.

If you give SeekNodeName parameter, we'll only look for nodes with X3DName = SeekNodeName. When SeekNodeName = '' it, consistently, looks for unnamed nodes (where X3DName = '').

Enumerates children only after enumerating Self. So you can modify children before enumerating them in the Proc callback. You can only modify your children in the Proc callback.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 769).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 771).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 773).

Search nodes, like enumerating nodes but allows early exit during the enumeration. We search for a node for which Proc(Node) returns something non-nil.

For every node, the given Proc callback is run. If the Proc callback returns something non-nil, the enumeration of the following nodes stops, and we return the callback result.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 786).

Warning: this symbol is deprecated: use FindNode(NodeClass: TX3DNodeClass, FindName: String, Options: TFindNodeOptions = [])

TryFindNodeByName and TryFindNode seek for a node with given class (and node name, in case of TryFindNodeByName). If OnlyActive then they seek among only active nodes ("active" as defined by Traverse), otherwise all nodes.

These functions are quite like EnumerateNodes, except they stop at the first occurrence and return it.

TryFindNodeByName and TryFindNode return Nil if such node is not found. FindNodeByName and FindNode raise exception EX3DNotFound in this case.

Exceptions raised

EX3DNotFound

FindNodeByName and FindNode raise this exception when node is not found.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 803).

Warning: this symbol is deprecated: use FindNode(NodeClass: TX3DNodeClass, FindName: String, Options: TFindNodeOptions = [])

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 806).

Warning: this symbol is deprecated: use FindNode(NodeClass: TX3DNodeClass, FindName: String, Options: TFindNodeOptions = [])

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 809).

Warning: this symbol is deprecated: use FindNode(NodeClass: TX3DNodeClass, FindName: String, Options: TFindNodeOptions = [])

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 811).

Find a node by name and class, in this node and children (recursively).

By default it searches both active and inactive graph parts. Add fnOnlyActive to search only in active parts.

Exceptions raised

EX3DNotFound

When node is not found. Unless fnNilOnMissing in Options, then it returns Nil on missing node, and EX3DNotFound is never raised.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 824).

Warning: this symbol is deprecated: use FindNode(NodeClass: TX3DNodeClass, FindName: String, Options: TFindNodeOptions = [])

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 827).

Warning: this symbol is deprecated: use FindNode to look for nodes easier; or iterate over TCastleScene.Shapes.TraverseList if you really need to know nodes with their TX3DGraphTraverseState

Find the first node with given class (NodeClass), return it's state or just transformation. Similar to Traverse, but stops as soon as the given node is found.

Returns False when not found ("out" parametrs Node, State and Transform are undefined then).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 845).

Warning: this symbol is deprecated: use FindNode to look for nodes easier; or iterate over TCastleScene.Shapes.TraverseList if you really need to know nodes with their transformations

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 849).

Seeks Self and parent nodes (from VRML1Parents and ParentFields, recursively) for given node name.

In other words, this is similar to TryNodeByName or NodeByName, but it goes "upward" in graph hierarchy. Note that this never restricts itself only to "active" graph part ("active" as defined by Traverse) because you really can't detect what is the "active" part of the graph when going upward.

Exceptions raised

EX3DNotFound

FindParentByName raises this exception when node is not found.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 870).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 871).

Looks for a given Node in parents (and self), recursively. Similar to TryFindParentByName. Returns True only if found.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 876).

Search immediate parents of this node for a node with given FindName. Returns Nil if not found.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 880).

Looks for a given node in our children (direct and not, including self). If OnlyActive, then only active parts are searched ("active" as defined by Traverse).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 885).

Count the occurrences of given node class in our children. For example, you can pass NodeClass = TAbstractLightNode to count the light sources in the scene.

If CountOnlyActiveNodes, then only active parts are searched ("active" as defined by Traverse).

This traverses both VRML 1.0 children nodes and VRML 2.0 nodes inside SFNode and MFNode fields.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 896).

Save node to a stream. Saves everything, including node name, node type, and node contents.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 901).

Do the nodes of (exactly) this class should be included in VRML 1.0 state (see TX3DGraphTraverseState.VRML1State).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 905).

Some nodes are present only in specific VRML/X3D version. This functions decides it.

For example some nodes can only work in VRML < 2.0, some others only in VRML >= 2.0. There are even some pairs of nodes: for example TConeNode_1 works with VRML < 2.0, TConeNode works with VRML >= 2.0.

NodesManager will use this.

Default implementation of this function returns always True. Generally, I don't try to set this too aggresively — in other words, for all cases when it's sensible, I allow nodes to be used in every VRML/X3D version, even when official specification doesn't. This means that when reading VRML 1.0 files actually a large part of VRML 2.0 is allowed too, and also while reading VRML 2.0 many constructs from VRML 1.0 (officially no longer present in VRML 2.0) are allowed too. I'm trying to support what I call a "sum of VRML 1.0 and 2.0".

In practice I only use this function when various VRML/X3D versions specify the same node name but

• With different fields.

  For example Cone and Cylinder have slightly different fields, due to the fact that VRML 2.0 resigned from using TSFBitMask fields.

• With different behavior.

  For example definitions of Sphere for VRML 1.0 and 2.0 are practically equal. However, the behavior from where to take texture and material info is different — in VRML 1.0 we take last Texture2, Material etc. nodes, while in VRML 2.0 we look in parent Shape's "appearance" field. So once again two different Sphere classes are needed.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 945).

Enumerates all children nodes (recursively), allowing you to decide for each node to replace or remove it.

So this is something like EnumerateNodes, except that it allows you to remove the nodes. It always enumerates all nodes, not only active (e.g. it enumerates all Switch node children, not only the chosen one).

Note that (unlike regular EnumerateNodes) this doesn't report Self to Func !. Which is natural, since this may remove nodes by normal VRML1ChildRemove calls, so it needs to know ParentNode of the removed node.

For each node Func will be called, with ParentNode and Node set. If you change the Node to something else, then the old node will be removed and new Node inserted in the same place. If new Node is Nil, then only the old node will be removed.

Nodes are traversed in depth-first search. Node is first reported to Func, and then (if it's not replaced) we descend into this Node.

Returns

The number of removed (and possibly replaced) nodes.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 970).

Removes all children (and their children, recursively) with node names matchig Wildcard. You can use * and ? special chars in the Wildcard.

Returns

The number of removed nodes.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 977).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 981).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 982).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 985).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 986).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 987).

Removes an X3D route (passing event between 2 nodes) from being stored in this node, and thus from being used. Note that TX3DRoute is "owned" by the node, and thus removing it also frees it.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 993).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 994).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 997).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 998).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1001).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1002).

Create a deep copy of this node and all it's children.

New copy is completely independent from original, having all children nodes (in both VRML 1.0 sense (Children) and VRML >= 2.0 (inside SFNode and MFNode fields)) also duplicated. New copy has protypes, routes, interface declarations and generally everything established like in the original, using copied nodes.

Doesn't copy things which are dependent on container hierarchy. (So copying them would be more dangerous than useful.) This means: DestructionNotifications, Scene, VRML1Parents, ParentFields. VRML1Parents and ParentFields will be set for children anyway (to appropriate copies).

Caller owns this newly created copy — as returned by this method, it's not linked anywhere.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1021).

Callbacks registered here will be called when this node is destroyed.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1100).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1101).

This will be always called by VRML parsers after adding new item to our InterfaceDeclarations.

In this class, this simply adds IDecl.FieldOrEvent to our normal fields/events by IDecl.AddFieldOrEvent. You may override this in subclasses to react in some special way to new fields/events, for example Script node may register here to receive notification when input event is received.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1129).

Add to node InterfaceDeclarations given field. This should only be used with nodes having HasInterfaceDeclarations = True, like Script or ComposedShader.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1134).

Add to node InterfaceDeclarations given field or event. This should only be used with nodes having HasInterfaceDeclarations = True, like Script or ComposedShader.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1139).

Nice and concise node description for user. Shows node type and name.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1143).

Detach this node from parent scene, recursively. Useful if you take a node and want to put it in another TCastleSceneCore.

You almost never need to call this method from your application. This is done automatically for you when TCastleSceneCore is destroyed. And a node can only be part of one TCastleSceneCore instance at one time.

Notable exceptions when you need to call this:

1. If you process RootNode graph and extract some node from it (that is, delete node from one RootNode graph, but instead of freeing it you insert it into some other VRML/X3D graph) you must call it to manually detach this node (and all it's children) from a previous TCastleSceneCore instance.

2. Right now the TCastleSceneCore doesn't call RootNode.UnregisterScene when TCastleSceneCore.OwnsRootNode. This is done for speed, because it's not needed in 99% cases.

   However, if your scene contains some node that isn't freed because of KeepExistingBegin or WaitForRelease, then such node will remain attached to non-existing scene. You should call UnregisterScene on such node manually, for now.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1177).

Find field set by given event of this node. Nil if not found (including when this Event doesn't actually belong to this node).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1181).

Find field that sends given event of this node. Nil if not found (including when this Event doesn't actually belong to this node).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1185).

Return an instance performing given functionality of this class (like a fog, transformation, material...), or Nil if none. This implements a simple component system inside TX3DNode, allowing some functionality to have common interface and implementation across a few nodes that are not otherwise related in the ancestor hierarchy.

Descendants should register TNodeFunctionality classes using AddFunctionality.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1195).

This item has no description.

Source: scene/x3d/x3dnodes_standard_core.inc (line 39).

Find a "metadata" information within this node with given key. Returns Nil if not found.

This seeks for a TAbstractMetadataNode instance within the X3D "metadata" field of this node. Looks for TAbstractMetadataNode with TAbstractMetadataNode.NameField matching the parameter Key. Note that X3D spec allows multiple metadata nodes to share the same key, this method only finds the first one.

It ignores TMetadataSet when searching, as TMetadataSet doesn't contain any simple data, it serves only as container for other metadata nodes.

Source: scene/x3d/x3dnodes_standard_core.inc (line 53).

Create node fields and events.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dnode.inc (line 33).

This item has no description. Showing description inherited from TX3DNode.ClassX3DType.

Node type name in VRML/X3D, for this class. Normal VRML/X3D node classes should override this to return something non-empty, and then X3DType automatically will return the same value.

Empty for classes that don't have a hardcoded VRML/X3D node name, like a special TX3DUnknownNode. Such special classes should override then X3DType to return actual non-empty name there.

You usually should call X3DType. The only use of this method is that it works on classes (it's "class function"), without needing at actual instance.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dnode.inc (line 34).

Create node fields and events.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dappearancechildnode.inc (line 28).

This item has no description. Showing description inherited from TX3DNode.ClassX3DType.

Node type name in VRML/X3D, for this class. Normal VRML/X3D node classes should override this to return something non-empty, and then X3DType automatically will return the same value.

Empty for classes that don't have a hardcoded VRML/X3D node name, like a special TX3DUnknownNode. Such special classes should override then X3DType to return actual non-empty name there.

You usually should call X3DType. The only use of this method is that it works on classes (it's "class function"), without needing at actual instance.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dappearancechildnode.inc (line 29).

Create node fields and events.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dshadernode.inc (line 31).

This item has no description. Showing description inherited from TX3DNode.ClassX3DType.

Node type name in VRML/X3D, for this class. Normal VRML/X3D node classes should override this to return something non-empty, and then X3DType automatically will return the same value.

Empty for classes that don't have a hardcoded VRML/X3D node name, like a special TX3DUnknownNode. Such special classes should override then X3DType to return actual non-empty name there.

You usually should call X3DType. The only use of this method is that it works on classes (it's "class function"), without needing at actual instance.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dshadernode.inc (line 32).

Position of this item within parent VRML/X3D node, used for saving the VRML/X3D graph to file. Default value -1 means "undefined".

For normal usage and processing of VRML graph, this is totally not needed. This position doesn't dictate actual meaning of VRML graph. If you're looking to change order of nodes, you probably want to rather look at something like ReplaceItems within TMFNode or such.

This field is purely a hint when encoding VRML file how to order VRML items (nodes, fields, routes, protos) within parent node or the VRML file. Reason: VRML allows non-unique node names. Each DEF XXX overrides all previous ("previous" in lexical sense, i.e. normal order of tokens in the file) DEF XXX with the same XXX, thus hiding previous node name "XXX". This means that when saving VRML file we have to be very careful about the order of items, such that e.g. all routes are specified when appropriate node names are bound.

This is a relative position, relative to other PositionInParent value of other TX3DFileItem items. So it's not necessary to keep all PositionInParent different or successive within some parent. When saving, we will sort everything according to PositionInParent.

See e.g. ../../../demo_models/x3d/tricky_def_use.x3dv for tests of some tricky layout. When reading such file we have to record PositionInParent to be able to save such file correctly.

Source: scene/x3d/castlefields_x3dfileitem.inc (line 71).

Node fields.

For normal nodes, all fields are created and added using AddField from the constructor. Fields default values are set, and current field values are set to these defaults. Later, we only modify these fields current values (e.g. when parsing).

However, there are special node classes that set their fields differently. TX3DPrototypeNode has their fields set according to it's VRML 2.0 prototype. TX3DUnknownNode may have it's fields set by VRML 1.0 "fields" feature (so it's Fields are initialized by parsing it).

Nodes with HasInterfaceDeclarations have some Fields and Events added when reading node.

All fields on this list are owned by this instance.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 338).

Explicit events (that is, not exposed by some field) of this node. For exposed events, see each field's property ExposedEvents.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 347).

VRML 1.0 children nodes. These are nodes directly specified inside a VRML 1.0 node, they don't belong to any node field. (In VRML 1.0, there was no SFNode / MFNode fields.)

In VRML 2.0, this is always empty.

VRML 1.0 nodes may have any number of children. The children nodes refer back to it's parent nodes in VRML1Parents list. When travelling over VRML/X3D graph, remember that cycles are possible, because of DEF/USE. Obviously, they possible when travelling along the VRML1Parents list. We currently assume that there are no cycles when we treat the graph as directed, but it may change one day (some VRML/X3D models create real cycles).

Adding/removing stuff from the VRML1Children list keeps track of how many times a node is used. If the child node has no parents, it will be freed. Actually, nodes can be children of both nodes (VRML 1.0 style, then VRML1Children and VRML1Parents is used) or fields (TMFNode or TSFNode, in VRML 2.0 style; then ParentFields is used). So the node is freed only when it's not referenced by any node and not referenced by any field. Generally, it's the parent that takes care of reference-counting and freeing the children, not the other way around.

Note that given node instance may be a children of a single node multiple times, through DEF/USE mechanism. The order of children is important and preserved. (On the other hand, the order of VRML1Parents is not important, as that list is mostly for reference-counting.)

You can replace one children with another like VRML1Children[I] := NewChildren;. This works like a shortcut for VRML1ChildRemove(I); VRML1ChildAdd(I, NewChildren);. But 1. it's more efficient; 2. it's safer — if Children[I] is already equal to NewChildren, it does nothing.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 409).

All VRML 1.0 parent nodes. VRML1Parents is a reverse of VRML1Children — it lists all the nodes where we are on VRML1Children list.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 439).

All SFNode and MFNode fields where this node is referenced. This is somewhat analogous for VRML1Parents, but for VRML 2.0.

ParentFieldsNode is just for your comfort, it returns always appropriate field's ParentNode property value (i.e. (ParentField[Index] as TSFNode).ParentNode or (ParentField[Index] as TMFNode).ParentNode).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 452).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 453).

Warning: this symbol is deprecated: do not access this directly; instead use TX3DNode.WaitForRelease and NodeRelease (eventually KeepExistingBegin and KeepExistingEnd) if you want to control node lifetime

When KeepExisting is non-zero, the node will not be automatically freed when it will become unused (when reference count changes from non-zero to zero). This is useful when you want to control the node lifetime explicitly.

For example, you may want to remove the node from X3D graph hierarchy, but keep a valid reference to it anyway (for example, maybe you'll free it later by hand or add it somewhere else).

Methods KeepExistingBegin and KeepExistingEnd simply increase / decrease KeepExisting value by 1. This is the most usual usage.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 502).

Name of this node. When saving/loading, this comes from VRML/X3D "DEF" construct. Empty value means that the name is not defined. Do not change this during loading / saving of the X3D graph, or searching for nodes e.g. by EnumerateNodes.

Note that this property is deliberately not called Name. In the future, this class may descend from the standard TComponent class, that defines a Name field with a special restrictions (it must be a valid Pascal identifier), which cannot apply to X3D node names (that can have quite free names, see http://www.web3d.org/documents/specifications/19776-2/V3.3/Part02/grammar.html ). We don't want to confuse these two properties.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 575).

Warning: this symbol is deprecated: use X3DName

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 577).

Base URL for all URLs inside our fields. Used everywhere as a base for relative URLs, to handle fields that refer to external files like textures, other 3D models (ImageTexture, Inline nodes, many others).

It must be an absolute URL. Currently, it doesn't have to contain a protocol, and is then interpreted as a path on local filesystem (just like it had file:// prefix). Still, it must be an absolute path.

This is set in constructor, and eventually adjusted by various parsing routines. This way we could, if only we would like to, resolve nodes like Inline or ImageTexture immediately after parsing them.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 593).

Warning: this symbol is deprecated.

Old deprecated name for BaseUrl.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 597).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 980).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 984).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 996).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1000).

PrototypeInstance = True indicates that this node was created from a non-external prototype instantiation.

Then PrototypeInstanceSourceNode is non-nil and indicates parsed prototype node (and PrototypeInstanceSourceNode.Prototype gives you even a link to the actual prototype specification).

PrototypeInstanceSourceNode is used for events: any ROUTEs specified outside of prototype and leading to/from instantiated prototype should actually lead to PrototypeInstanceSourceNode events (not to events of Self). Reason: prototype events may be different than actual expanded node events, and ROUTEs want to lead to prototype events. This is implemented when expanding prototype (TX3DPrototypeNode.Instantiate) and when linking ROUTE (TX3DRoute.SetSource, TX3DRoute.SetDestination).

PrototypeInstanceHelpers may be Nil if empty, or may contain a list of other nodes duplicated along with the main prototype node. From VRML spec:

Any other nodes and accompanying scene graphs are not part of the transformation hierarchy, but may be referenced by ROUTE statements or Script nodes in the prototype definition.

Note that for TX3DPrototypeNode (within PrototypeInstanceSourceNode) these have a little different meaning: they describe the nested prototype, if any, that was used to create this node. This may happen if the node was expanded from one prototype within another. (Usually, you shouldn't be concerned about this; see TX3DPrototypeNode.Instantiate implementation comments for gory details about this.)

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1057).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1058).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1060).

Default value of "containerField" attribute for this node in X3D XML encoding.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1065).

For some special VRML / X3D nodes (like Script, ComposedShader) that allow the definition of additional fields/events within.

In X3D specification this is marked like

# And any number of:
fieldType [in]     fieldName
fieldType [in,out] fieldName    initialValue
fieldType [out]    fieldName
fieldType []       fieldName    initialValue

If HasInterfaceDeclarations is not [], then InterfaceDeclarations will be non-nil and parser (classic VRML parser in this unit, X3D XML reader too) will read this from VRML files. Moreover, for each interface declaration, also appropriate field/event will be added to the list of Fields or Events, so fields/events created by interface declarations will function just like other standard fields everywhere.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1090).

This item has no description.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1094).

Scene that will be notified about changes to this node. This is necessary to allow the scene to properly process VRML/X3D events, and also to react properly to any other changes to the nodes (like when you change some field directly by ObjectPascal code, e.g. by TX3DField.Send).

May be Nil if none.

A given TX3DNode may be renderable only by a single renderer. This means it can be placed only within one TCastleScene.

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1114).

Fast shortcut to Functionality(TTransformFunctionality).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1199).

Fast shortcut to Functionality(TTimeDependentFunctionality).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1201).

Fast shortcut to Functionality(TGeneratedTextureFunctionality).

Source: scene/x3d/x3dnodes_x3dnode.inc (line 1203).

Get/set metadata, identified by a given Key, as a Boolean. "Metadata" is any value you want to save with this node, it has no effect on the rendering/behavior. This property hides various complexities of the X3D metadata nodes.

This property looks for a TMetadataBooleanNode node inside the "metadata" of this node using FindMetadata. If found, it allows to operate TMetadataBooleanNode.FdValue array. The MetadataBooleanArray allows to get/set appropriate items of this array. The MetadataBoolean simply gets/sets the first array item.

If such metadata node is not found, or it's TMetadataBooleanNode.FdValue array is too short, this returns false. When setting, it adds such metadata node if necessary, and increases the TMetadataBooleanNode.FdValue array length if necessary.

Source: scene/x3d/x3dnodes_standard_core.inc (line 70).

This item has no description.

Source: scene/x3d/x3dnodes_standard_core.inc (line 71).

Get/set metadata, identified by a given Key, as a String. "Metadata" is any value you want to save with this node, it has no effect on the rendering/behavior. This property hides various complexities of the X3D metadata nodes.

This property looks for a TMetadataStringNode node inside the "metadata" of this node using FindMetadata. If found, it allows to operate TMetadataStringNode.FdValue array. The MetadataStringArray allows to get/set appropriate items of this array. The MetadataString simply gets/sets the first array item.

If such metadata node is not found, or it's TMetadataStringNode.FdValue array is too short, this returns ''. When setting, it adds such metadata node if necessary, and increases the TMetadataStringNode.FdValue array length if necessary.

Source: scene/x3d/x3dnodes_standard_core.inc (line 88).

This item has no description.

Source: scene/x3d/x3dnodes_standard_core.inc (line 89).

Get/set metadata, identified by a given Key, as a Integer. "Metadata" is any value you want to save with this node, it has no effect on the rendering/behavior. This property hides various complexities of the X3D metadata nodes.

This property looks for a TMetadataIntegerNode node inside the "metadata" of this node using FindMetadata. If found, it allows to operate TMetadataIntegerNode.FdValue array. The MetadataIntegerArray allows to get/set appropriate items of this array. The MetadataInteger simply gets/sets the first array item.

If such metadata node is not found, or it's TMetadataIntegerNode.FdValue array is too short, this returns 0. When setting, it adds such metadata node if necessary, and increases the TMetadataIntegerNode.FdValue array length if necessary.

Source: scene/x3d/x3dnodes_standard_core.inc (line 106).

This item has no description.

Source: scene/x3d/x3dnodes_standard_core.inc (line 107).

Get/set metadata, identified by a given Key, as a Double. "Metadata" is any value you want to save with this node, it has no effect on the rendering/behavior. This property hides various complexities of the X3D metadata nodes.

This property looks for a TMetadataDoubleNode or TMetadataFloatNode node inside the "metadata" of this node using FindMetadata. If found, it allows to operate TMetadataDoubleNode.FdValue array or TMetadataFloatNode.FdValue array. The MetadataDoubleArray allows to get/set appropriate items of this array. The MetadataDouble simply gets/sets the first array item.

If such metadata node is not found, or it's TMetadataDoubleNode.FdValue array is too short, this returns 0.0. When setting, it adds such metadata node if necessary, and increases the TMetadataDoubleNode.FdValue array length if necessary.

Source: scene/x3d/x3dnodes_standard_core.inc (line 125).

This item has no description.

Source: scene/x3d/x3dnodes_standard_core.inc (line 126).

Internal wrapper for property Metadata. This wrapper API may change, we advise to access simpler Metadata instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dnode.inc (line 39).

This item has no description.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dnode.inc (line 43).

This item has no description.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dshadernode.inc (line 36).

This item has no description.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dshadernode.inc (line 40).

This item has no description.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dshadernode.inc (line 44).

Internal wrapper for property Language. This wrapper API may change, we advise to access simpler Language instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dshadernode.inc (line 48).

Shading language. Only the GLSL (OpenGL Shading Language) is actually supported. The default value, empty string, is equivalent to GLSL.

Source: scene/x3d/auto_generated_node_helpers/x3dnodes_x3dshadernode.inc (line 50).