API Reference

Class TViewpointGroupNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TViewpointGroupNode = class(TAbstractChildNode)

Description

Group of viewpoints. You can (optionally) arrange viewpoints in groups to present them nicely in the X3D browser submenus.

Hierarchy

Overview

Methods

Protected function DirectEnumerateActive(Func: TEnumerateChildrenFunction): Pointer; override;
Public function SmartDescription: string;
Public procedure CreateNode; override;
Public class function ClassX3DType: String; override;
Public procedure SetChildren(const Value: array of TX3DNode);

Properties

Public property FdCenter: TSFVec3f read FFdCenter;
Public property Center: TVector3 read GetCenter write SetCenter;
Public property FdChildren: TMFNode read FFdChildren;
Public property FdDescription: TSFString read FFdDescription;
Public property Description: String read GetDescription write SetDescription;
Public property FdDisplayed: TSFBool read FFdDisplayed;
Public property Displayed: Boolean read GetDisplayed write SetDisplayed;
Public property FdRetainUserOffsets: TSFBool read FFdRetainUserOffsets;
Public property RetainUserOffsets: Boolean read GetRetainUserOffsets write SetRetainUserOffsets;
Public property FdSize: TSFVec3f read FFdSize;
Public property Size: TVector3 read GetSize write SetSize;

Description

Methods

Protected function DirectEnumerateActive(Func: TEnumerateChildrenFunction): Pointer; override;

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

Enumerate all active child nodes of given node.

"Active nodes" are the ones affecting current look or collisions, e.g. from Switch node only one child will be enumerated. See Traverse for more precise definition.

"Direct" means that this enumerates only direct descendants, i.e. this is not recursive. See methods like Traverse or EnumerateNodes if you want recursive behavior.

This can enumerate both VRML1Children nodes and nodes within TSFNode and TMFNode fields.

Default implementation in this class enumerates all Children nodes of VRML 1.0. If you need to remove some children for VRML 1.0 (e.g. for Switch or LOD nodes) or add some children for VRML 2.0 you have to override this. You do not need to call inherited when overriding this — in fact, you should not, if you want to omit some nodes.

Stops and returns immediately if Func returns non-nil for some child.

Public function SmartDescription: string;

Description generated smart (trying to use FdDescription field, falling back on other information to help user identify the node).

Public procedure CreateNode; override;

Create node fields and events.

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 SetChildren(const Value: array of TX3DNode);

This item has no description.

Properties

Public property FdCenter: TSFVec3f read FFdCenter;

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

Public property Center: TVector3 read GetCenter write SetCenter;

This item has no description.

Public property FdChildren: TMFNode read FFdChildren;

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

Public 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).

Public property Description: String read GetDescription write SetDescription;

This item has no description.

Public property FdDisplayed: TSFBool read FFdDisplayed;

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

Public property Displayed: Boolean read GetDisplayed write SetDisplayed;

This item has no description.

Public property FdRetainUserOffsets: TSFBool read FFdRetainUserOffsets;

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

Public property RetainUserOffsets: Boolean read GetRetainUserOffsets write SetRetainUserOffsets;

This item has no description.

Public property FdSize: TSFVec3f read FFdSize;

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

Public property Size: TVector3 read GetSize write SetSize;

This item has no description.

Generated by PasDoc 0.16.0-snapshot.

Copyright Michalis Kamburelis and Castle Game Engine Contributors.

This webpage is also open-source and we welcome pull requests to improve it.

We use cookies for analytics. See our privacy policy.