Class TInlineNode

Description

Hierarchy

Fields

Methods

Properties

Unit

X3DNodes

Declaration

type TInlineNode = class(TAbstractInternalGroupingNode)

Description

Embed another X3D scene into the current scene.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 95).

Hierarchy

Overview

Methods

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

Properties

	`property Inlined: TX3DRootNode read FInlined;`
	`property FdAutoRefresh: TSFTime read FFdAutoRefresh;`
	`property AutoRefresh: TFloatTime read GetAutoRefresh write SetAutoRefresh;`
	`property FdAutoRefreshTimeLimit: TSFTime read FFdAutoRefreshTimeLimit;`
	`property AutoRefreshTimeLimit: TFloatTime read GetAutoRefreshTimeLimit write SetAutoRefreshTimeLimit;`
	`property FdBboxDisplay: TSFBool read FFdBboxDisplay;`
	`property BboxDisplay: Boolean read GetBboxDisplay write SetBboxDisplay;`
	`property FdDescription: TSFString read FFdDescription;`
	`property Description: String read GetDescription write SetDescription;`
	`property FdGlobal: TSFBool read FFdGlobal;`
	`property Global: Boolean read GetGlobal write SetGlobal;`
	`property FdLoad: TSFBool read FFdLoad;`
	`property Load: Boolean read GetLoad write SetLoad;`
	`property FdUrl: TMFString read FFdUrl;`
	`property FdVisible: TSFBool read FFdVisible;`
	`property Visible: Boolean read GetVisible write SetVisible;`
	`property FdBboxCenter: TSFVec3f read FFdBboxCenter;`
	`property BBox: TBox3D read GetBBox write SetBBox;`
	`property FdBboxSize: TSFVec3f read FFdBboxSize;`

Description

Methods

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.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 110).

procedure AfterTraverse(StateStack: TX3DGraphTraverseStateStack); override;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 111).

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.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 116).

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.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 117).

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.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 119).

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.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 121).

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.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 123).

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.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 149).

procedure UnLoadInlined;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 153).

procedure LoadedInlineDirectly;

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

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 157).

procedure CreateNode; override;

Create node fields and events.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 45).

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.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 46).

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

URL of the content to be loaded. Multiple URLs can be provided, each one will be tried in turn.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 88).

procedure SetUrl(const Value: TCastleStringList); overload;

URL of the content to be loaded. Multiple URLs can be provided, each one will be tried in turn.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 90).

Properties

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.

Source: src/scene/x3d/x3dnodes_standard_networking.inc (line 165).

property FdAutoRefresh: TSFTime read FFdAutoRefresh;

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

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

property AutoRefresh: TFloatTime read GetAutoRefresh write SetAutoRefresh;

Not implemented. Interval in seconds between automatically reloading the content.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 52).

property FdAutoRefreshTimeLimit: TSFTime read FFdAutoRefreshTimeLimit;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 56).

property AutoRefreshTimeLimit: TFloatTime read GetAutoRefreshTimeLimit write SetAutoRefreshTimeLimit;

Not implemented. Maximum duration that automatic refresh activity can take.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 58).

property FdBboxDisplay: TSFBool read FFdBboxDisplay;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 62).

property BboxDisplay: Boolean read GetBboxDisplay write SetBboxDisplay;

Not implemented. Display the bounding box of the inline object.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 64).

property FdDescription: TSFString read FFdDescription;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 68).

property Description: String read GetDescription write SetDescription;

Textual description of the inlined content.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 70).

property FdGlobal: TSFBool read FFdGlobal;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 74).

property Global: Boolean read GetGlobal write SetGlobal;

Not implemented. Whether lights contained in the Inline scene are allowed to have external lighting effects or not.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 76).

property FdLoad: TSFBool read FFdLoad;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 80).

property Load: Boolean read GetLoad write SetLoad;

Partially implemented. When False, defers when the referenced content is read and displayed.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 82).

property FdUrl: TMFString read FFdUrl;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 86).

property FdVisible: TSFBool read FFdVisible;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 94).

property Visible: Boolean read GetVisible write SetVisible;

Not implemented. Whether or not the content within a node is visually displayed. The value of this field has no effect on animation behaviors, collision behaviors, event passing, or other non-visual characteristics.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 96).

property FdBboxCenter: TSFVec3f read FFdBboxCenter;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 100).

property BBox: TBox3D read GetBBox write SetBBox;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 102).

property FdBboxSize: TSFVec3f read FFdBboxSize;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_inline.inc (line 106).

Generated by PasDoc 0.17.0.snapshot.

API Reference

Class TInlineNode

Unit

Declaration

Description

Hierarchy

Overview

Methods

Properties

Description

Methods

Parameters

Properties