Class TMFNode
Unit
Declaration
type TMFNode = class(TX3DMultField)
Description
VRML/X3D field holding a list of nodes.
Just like SFNode, it's defined in this unit, as it uses TX3DNode. Note that items of MFNode cannot be nil (i.e. VRML/X3D doesn't allow to use NULL inside MFNode), contrary to SFNode.
Note that TMFNode
implementation doesn't use TX3DSimpleMultField. One reason is that we don't want to parse MFNode items by SFNode parser, because MFNode doesn't allow NULL items. (In the past, another argument was that we want to use TX3DNodeList and it wasn't compatible with TX3DSimpleMultField. But now TX3DNodeList descends from TFPSList, so it isn't a problem.)
Just like for TSFNode: Note that we store AllowedChildren list, which is a list of classes allowed as Items. But this is used only to produce warnings for a user. You should never assert that every item actually is one the requested classes.
Hierarchy
- TObject
- TPersistent
- TX3DFileItem
- TX3DFieldOrEvent
- TX3DField
- TX3DMultField
- TMFNode
Overview
Methods
constructor CreateUndefined(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: String); override; |
|
constructor Create(const AParentNode: TX3DNode; const AExposed: boolean; const AName: String; const AAllowedChildrenClasses: array of TX3DNodeClass); overload; |
|
constructor Create(const AParentNode: TX3DNode; const AExposed: boolean; const AName: String; const AAllowedChildrenClasses: TX3DNodeClassesList); overload; |
|
constructor Create(const AParentNode: TX3DNode; const AExposed: boolean; const AName: String; const AnAllowedChildrenFunctionality: TNodeFunctionalityClass); overload; |
|
destructor Destroy; override; |
|
function GetEnumerator: TEnumerator; |
|
procedure Replace(const Index: Integer; Node: TX3DNode); |
|
procedure Add(Node: TX3DNode); overload; |
|
procedure Add(Position: Integer; Node: TX3DNode); overload; |
|
procedure Delete(Index: Integer); |
|
function Remove(const Node: TX3DNode): Integer; |
|
function Extract(Index: Integer): TX3DNode; |
|
procedure Clear; |
|
procedure AssignItems(const SourceItems: TX3DNodeList); overload; |
|
procedure AssignItems(const SourceItems: array of TX3DNode); overload; |
|
procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); override; |
|
procedure ParseXMLAttribute(const AttributeValue: String; Reader: TX3DReader); override; |
|
procedure ParseXMLElement(Element: TDOMElement; Reader: TX3DReader); override; |
|
function EqualsDefaultValue: boolean; override; |
|
function Equals(SecondValue: TX3DField): boolean; override; |
|
procedure Assign(Source: TPersistent); override; |
|
procedure AssignValue(Source: TX3DField); override; |
|
procedure AssignDefaultValueFromValue; override; |
|
procedure UnassignDefaultValue; override; |
|
class function X3DType: String; override; |
|
class function CreateEvent(const AParentNode: TX3DFileItem; const AName: String; const AInEvent: boolean): TX3DEvent; override; |
|
procedure WarningIfChildNotAllowed(Child: TX3DNode); |
|
function ChildAllowed(Child: TX3DNode): boolean; |
|
procedure AssignDefaultItems(const SourceDefaultItems: TX3DNodeList); |
|
procedure ClearDefault; |
|
function Enumerate(Func: TEnumerateChildrenFunction): Pointer; |
|
procedure Send(const AValue: array of TX3DNode); overload; |
|
function FindName(const AName: String): TX3DNode; |
|
function IndexOfName(const AName: String): Integer; |
|
function IndexOf(const ANode: TX3DNode): Integer; |
Properties
property Items[const Index: Integer]: TX3DNode read GetItems write Replace; |
|
property ItemsArray[Index: Integer]: TX3DNode read GetItems; deprecated 'use Items (default array property)'; |
|
property ParentNode: TX3DNode read FParentNode; |
|
property DefaultItems: TX3DNodeList read FDefaultItems; |
|
property DefaultValueExists: boolean
read FDefaultValueExists write FDefaultValueExists default false; |
Description
Methods
constructor CreateUndefined(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: String); override; |
|
Construct a field allowing any children class. Suitable only for special cases. For example, in instantiated prototypes, we must initially just allow all children, otherwise valid prototypes with SFNode/MFNode would cause warnings when parsing. |
constructor Create(const AParentNode: TX3DNode; const AExposed: boolean; const AName: String; const AAllowedChildrenClasses: array of TX3DNodeClass); overload; |
|
This item has no description. |
constructor Create(const AParentNode: TX3DNode; const AExposed: boolean; const AName: String; const AAllowedChildrenClasses: TX3DNodeClassesList); overload; |
|
Constructor that takes a list of allowed children classes. Note that we copy the contents of AAllowedChildrenClasses, not the reference. |
constructor Create(const AParentNode: TX3DNode; const AExposed: boolean; const AName: String; const AnAllowedChildrenFunctionality: TNodeFunctionalityClass); overload; |
|
Constructor that allows as children any implementor of given functionality. |
destructor Destroy; override; |
|
This item has no description. |
function GetEnumerator: TEnumerator; |
|
This item has no description. |
procedure Replace(const Index: Integer; Node: TX3DNode); |
|
This item has no description. |
procedure Add(Node: TX3DNode); overload; |
|
This item has no description. |
procedure Add(Position: Integer; Node: TX3DNode); overload; |
|
This item has no description. |
procedure Delete(Index: Integer); |
|
This item has no description. |
function Remove(const Node: TX3DNode): Integer; |
|
Search list for given node, and, if found, remove it. Returns the index of removed item, or -1 if not found. |
function Extract(Index: Integer): TX3DNode; |
|
Remove child with given Index, and return it, never freeing it. This is analogous to TX3DNode.ExtractChild, see there for more explanation. |
procedure Clear; |
|
This item has no description. |
procedure AssignItems(const SourceItems: TX3DNodeList); overload; |
|
This item has no description. |
procedure AssignItems(const SourceItems: array of TX3DNode); overload; |
|
This item has no description. |
procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); override; |
|
This item has no description. |
procedure ParseXMLAttribute(const AttributeValue: String; Reader: TX3DReader); override; |
|
This item has no description. Showing description inherited from TX3DField.ParseXMLAttribute. Parse field value from X3D XML encoded attribute. Implementation in this class creates a Lexer to parse the string, and calls ParseXMLAttributeLexer. |
procedure ParseXMLElement(Element: TDOMElement; Reader: TX3DReader); override; |
|
This item has no description. Showing description inherited from TX3DField.ParseXMLElement. Parse field's value from XML Element children. This is used to read SFNode / MFNode field value inside <field> (for interface declaration default field value) and <fieldValue> inside <ProtoInstance>. |
function EqualsDefaultValue: boolean; override; |
|
This item has no description. Showing description inherited from TX3DField.EqualsDefaultValue.
Whether the value is equal to default. Returns always |
function Equals(SecondValue: TX3DField): boolean; override; |
|
This item has no description. Showing description inherited from TX3DField.Equals.
All descendants (that add some property that should be compared) should override this like Result := (inherited Equals(SecondValue)) and (SecondValue is TMyType) and (TMyType(SecondValue).MyProperty = MyProperty);
The floating-point fields may be compared with a small epsilon tolerance by this method. Note that this *doesn't* compare the default values of two fields instances. This compares only the current values of two fields instances, and eventually some other properties that affect parsing (like names for TSFEnum and TSFBitMask) or allowed future values (like TSFFloat.MustBeNonnegative). |
procedure Assign(Source: TPersistent); override; |
|
This item has no description. |
procedure AssignValue(Source: TX3DField); override; |
|
This item has no description. Showing description inherited from TX3DField.AssignValue. Copies the current field value. Contrary to TPersistent.Assign, this doesn't copy the rest of properties. After setting, our ValueFromIsClause is always changed to
Descendants implementors notes: In this class, implementation takes care of setting our ValueFromIsClause to if Source is <appropriate class> then begin inherited; Value := Source.value; end else AssignValueRaiseInvalidClass(Source); |
procedure AssignDefaultValueFromValue; override; |
|
This item has no description. Showing description inherited from TX3DField.AssignDefaultValueFromValue. Set field's default value from the current value. Note that for now this doesn't guarantee that every possible field's value can be stored as default value. In case of trouble, it will silently record "no default is known" information, so e.g. EqualsDefaultValue will always return |
procedure UnassignDefaultValue; override; |
|
This item has no description. Showing description inherited from TX3DField.UnassignDefaultValue.
Remove default value, recording that "no default is known". In effect EqualsDefaultValue will always return |
class function X3DType: String; override; |
|
This item has no description. Showing description inherited from TX3DField.X3DType.
Field type in X3D, like |
class function CreateEvent(const AParentNode: TX3DFileItem; const AName: String; const AInEvent: boolean): TX3DEvent; override; |
|
This item has no description. Showing description inherited from TX3DField.CreateEvent. Create TX3DEvent descendant suitable as exposed event for this field. |
procedure WarningIfChildNotAllowed(Child: TX3DNode); |
|
Checks is Child allowed on the list of nodes of this MFNode, and makes WritelnWarning if not. Check is allowed is done looking at AllowedChildrenAll and AllowedChildren properties. Child must not be WritelnWarning message will suggest that this Child is added to this node. In other words, you should only pass as Child a node that you want to add (e.g. by Add) to this field, otherwise WritelnWarning message will be a little unsensible. |
function ChildAllowed(Child: TX3DNode): boolean; |
|
This item has no description. |
procedure AssignDefaultItems(const SourceDefaultItems: TX3DNodeList); |
|
Operate on DefaultItems, just like analogous AssignItems and Clear. |
procedure ClearDefault; |
|
This item has no description. |
function Enumerate(Func: TEnumerateChildrenFunction): Pointer; |
|
Calls Func for all current children. Stops if Func returns something non-nil. The main use for this is to simplify implementation of TX3DNode.DirectEnumerateActive overrides in TX3DNode descendants. |
procedure Send(const AValue: array of TX3DNode); overload; |
|
Set the field's value in a correct way (by sending X3D event, or at least notifying the parent scene). |
function FindName(const AName: String): TX3DNode; |
|
Find node by name, For empty node name, always returns See also
|
function IndexOfName(const AName: String): Integer; |
|
Find index of a node with given name, -1 if not found. |
function IndexOf(const ANode: TX3DNode): Integer; |
|
Find index of a node , -1 if not found. |
Properties
property Items[const Index: Integer]: TX3DNode read GetItems write Replace; |
|
Items of this field. |
property ItemsArray[Index: Integer]: TX3DNode read GetItems; deprecated 'use Items (default array property)'; |
|
Warning: this symbol is deprecated: use Items (default array property) This item has no description. |
property ParentNode: TX3DNode read FParentNode; |
|
This item has no description. |
property DefaultItems: TX3DNodeList read FDefaultItems; |
|
Lists default items of this field. Do not modify this list explicitly. Use only methods in this class like AssignDefaultItems (they take care of calling appropriate AddParentField / RemoveParentField, otherwise you could break reference-counting of nodes by ParentFields). |
property DefaultValueExists: boolean
read FDefaultValueExists write FDefaultValueExists default false; |
|
This item has no description. |
Generated by PasDoc 0.16.0-snapshot.