Class TInlineNode

Unit

Declaration

type TInlineNode = class(TAbstractInternalGroupingNode)

Description

Embed another X3D scene into the current scene.

Hierarchy

Overview

Methods

Protected procedure BeforeTraverse(StateStack: TX3DGraphTraverseStateStack); override;
Protected procedure AfterTraverse(StateStack: TX3DGraphTraverseStateStack); override;
Protected procedure AfterLoadInlined; virtual;
Protected procedure ParseAfter(Reader: TX3DReaderNames); override;
Protected function DeepCopyCore(CopyState: TX3DNodeDeepCopyState): TX3DNode; override;
Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;
Public class function VRML1ChildrenSaveToStream: boolean; override;
Public procedure LoadInlined(CanReload: boolean; const CurrentLengthConversionFactor: Float = 1.0; const Exported: TX3DNodeNames = nil);
Public procedure UnLoadInlined;
Public procedure LoadedInlineDirectly;
Public procedure CreateNode; override;
Public class function ClassX3DType: string; override;
Public procedure SetUrl(const Value: array of string); overload;
Public procedure SetUrl(const Value: TCastleStringList); overload;

Properties

Public property Inlined: TX3DRootNode read FInlined;
Public property FdLoad: TSFBool read FFdLoad;
Public property Load: Boolean read GetLoad write SetLoad;
Public property FdUrl: TMFString read FFdUrl;
Public property FdBboxCenter: TSFVec3f read FFdBboxCenter;
Public property BBox: TBox3D read GetBBox write SetBBox;
Public property FdBboxSize: TSFVec3f read FFdBboxSize;

Description

Methods

Protected procedure BeforeTraverse(StateStack: TX3DGraphTraverseStateStack); override;

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

Override these methods to determine what happens when given node is traversed during Traverse call. The main use of this is to operate on TX3DGraphTraverseStateStack.

Remember to always call inherited when overriding. In BeforeTraverse and MiddleTraverse you should call inherited at the beginning, in AfterTraverse inherited should be called at the end.

Besides changing StateStack.Top fields, you can do push/pop on the stack. Remember that if you do StateStack.Push in BeforeTraverse, and then you must call StateStack.Pop in AfterTraverse.

Protected procedure AfterTraverse(StateStack: TX3DGraphTraverseStateStack); override;

This item has no description.

Protected procedure AfterLoadInlined; virtual;

You can override this to do anything after the Inline children were loaded. It's called only after actual loading occurred, e.g. it's not called when LoadInlined was called on the already-loaded node with CanReload = False.

Protected procedure ParseAfter(Reader: TX3DReaderNames); override;

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

Called at the end of parsing this node (including children) in any encoding.

Protected function DeepCopyCore(CopyState: TX3DNodeDeepCopyState): TX3DNode; override;

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

Does actual DeepCopy work. You can override this to copy some more properties for descendants.

Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;

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

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.

Public class function VRML1ChildrenSaveToStream: boolean; override;

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

Should SaveToStream save our VRML1Children. In this class default implementation returns True, this is what you will want in 99% of cases. It's useful to set this to false if you use VRML1Children internally, e.g. *Inline nodes.

Public procedure LoadInlined(CanReload: boolean; const CurrentLengthConversionFactor: Float = 1.0; const Exported: TX3DNodeNames = nil);

Load inlined content now. If Inlined is already loaded: if CanReload = True then it will be freed and loaded again, else (if CanReload = False) nothing will happen.

Note that this has a really simple support for "load" field (this concerns VRML 97 amendment 1 "InlineLoadControl.load" and X3D (actually used also in VRML 97 handling) "Inline.load" fields). It simply doesn't do any loading when "load" = False.

Note that this doesn't perform setting the "load" field, or sending any notifications to Scene about "load" field. It's the caller's job to keep loaded state synchronized with "load" field value.

LoadInlined(false) will be called automatically, to ensure the inlined contents are always loaded. It will be called at the end of Parse (this is needed to handle VRML/X3D IMPORT/EXPORT mechanism), it will also be called in BeforeTraverse (in case you constructed node by code, not by parsing; this also happens when node was made by expanding a PROTO).

Parameters
Exported
If non-nil, we will assign here node names exported from the file. Used to handle IMPORT/EXPORT X3D mechanism.
Public procedure UnLoadInlined;

This item has no description.

Public procedure LoadedInlineDirectly;

Call this to indicate that you loaded the inline contents directly, by using AddChild yourself.

Public procedure CreateNode; override;

This item has no description. Showing description inherited from TAbstractChildNode.CreateNode.

Automatically generated node properties.

Do not edit this file manually! To add new properties: - add them to the text files in tools/internal/x3d-nodes-to-pascal/nodes-specification/ , - and regenerate include files by running x3d-nodes-to-pascal

Public class function ClassX3DType: string; override;

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.

Public procedure SetUrl(const Value: array of string); overload;

This item has no description.

Public procedure SetUrl(const Value: TCastleStringList); overload;

This item has no description.

Properties

Public property Inlined: TX3DRootNode read FInlined;

The inlined content (loaded from inlined url). Nil if not yet loaded, or no loading was successful.

This is also kept in VRML 1.0 children list as VRML1Children[0], but for future it's better to not depend on that. But it will always be enumerated by things like TX3DNode.EnumerateNodes.

Public property FdLoad: TSFBool read FFdLoad;

Internal wrapper for property Load. This wrapper API may change, we advise to access simpler Load instead.

Public property Load: Boolean read GetLoad write SetLoad;

This item has no description.

Public property FdUrl: TMFString read FFdUrl;

Internal wrapper for property Url. This wrapper API may change, we advise to access simpler Url instead.

Public property FdBboxCenter: TSFVec3f read FFdBboxCenter;

Internal wrapper for property BboxCenter. This wrapper API may change, we advise to access simpler BboxCenter instead.

Public property BBox: TBox3D read GetBBox write SetBBox;

This item has no description.

Public property FdBboxSize: TSFVec3f read FFdBboxSize;

Internal wrapper for property BboxSize. This wrapper API may change, we advise to access simpler BboxSize instead.


Generated by PasDoc 0.16.0.