Class TMFString
Unit
Declaration
type TMFString = class(TX3DMultField)
Description
This item has no description. Showing description inherited from TX3DMultField.
X3D field with a list of values.
Hierarchy
- TObject
- TPersistent
- TX3DFileItem
- TX3DFieldOrEvent
- TX3DField
- TX3DMultField
- TMFString
Overview
Methods
![]() |
constructor Create(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: string; const InitialContent: array of string); |
![]() |
constructor CreateUndefined(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: string); override; |
![]() |
destructor Destroy; override; |
![]() |
function FastEqualsValue(SecondValue: TX3DField): boolean; override; |
![]() |
procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); override; |
![]() |
class function X3DType: string; override; |
![]() |
class function CreateEvent(const AParentNode: TX3DFileItem; const AName: string; const AInEvent: boolean): TX3DEvent; override; |
![]() |
procedure ParseXMLAttribute(const AttributeValue: string; Reader: TX3DReader); override; |
![]() |
function SaveToXmlValue: TSaveToXmlMethod; override; |
![]() |
procedure Assign(Source: TPersistent); override; |
![]() |
procedure AssignValue(Source: TX3DField); override; |
![]() |
procedure AssignDefaultValueFromValue; override; |
![]() |
procedure UnassignDefaultValue; override; |
![]() |
function Equals(SecondValue: TX3DField): boolean; override; |
![]() |
function EqualsDefaultValue: boolean; override; |
![]() |
procedure Send(const AValue: array of string); overload; |
![]() |
procedure Send(const AValue: TCastleStringList); overload; |
Properties
![]() |
property Items: TCastleStringList read FItems write SetItems; |
![]() |
property ItemsSafe[Index: Integer]: string read GetItemsSafe write SetItemsSafe; |
Description
Methods
![]() |
constructor Create(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: string; const InitialContent: array of string); |
This item has no description. |
![]() |
constructor CreateUndefined(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: string); override; |
This item has no description. Showing description inherited from TX3DField.CreateUndefined. Virtual constructor, that you can use to construct field instance when field class is known only at runtime. The idea is that in some cases, you need to create fields using variable like FieldClass: TX3DFieldClass. See e.g. TX3DInterfaceDeclaration, VRML 2.0 feature that simply requires this ability, also implementation of TX3DSimpleMultField.Parse and TX3DSimpleMultField.CreateItemBeforeParse. Later you can initialize such instance from string using it's Parse method. Note that some exceptional fields simply cannot work when initialized by this constructor: these are SFEnum and SFBitMask fields. They simply need to know their TSFEnum.EnumNames, or TSFBitMask.FlagNames + TSFBitMask.NoneString + TSFBitMask.AllString before they can be parsed. I guess that's one of the reasons why these field types were entirely removed from VRML 2.0. |
![]() |
destructor Destroy; override; |
This item has no description. |
![]() |
function FastEqualsValue(SecondValue: TX3DField): boolean; override; |
This item has no description. Showing description inherited from TX3DField.FastEqualsValue. Compare value of this field, with other field, fast. This compares only the values of the fields, not other properties (it doesn't care about names of the fields or such, or default values; only current values). In other words, it compares only the things copied by AssignValue. This tries to compare very fast, which means that for large (multi-valued) fields it may give up and answer Default implementation in this class ( |
![]() |
procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); override; |
Parse MF field. This class handles parsing fully, usually no need to override this more in descendants. It uses TSingleField.Parse method. |
![]() |
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 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. |
![]() |
function SaveToXmlValue: TSaveToXmlMethod; override; |
This item has no description. |
![]() |
procedure Assign(Source: TPersistent); override; |
Copy another field value, default value and other properties. |
![]() |
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 |
![]() |
function Equals(SecondValue: TX3DField): boolean; override; |
Checks equality between this and SecondValue field. In addition to inherited(Equals), this checks the actual contents of the items. Note that floating-point values are compared with some tolerance for errors by this method. |
![]() |
function EqualsDefaultValue: boolean; override; |
This item has no description. Showing description inherited from TX3DField.EqualsDefaultValue.
Whether the value is equal to default. Returns always |
![]() |
procedure Send(const AValue: array of string); overload; |
Set the field's value in a correct way (by sending X3D event, or at least notifying the parent scene). |
![]() |
procedure Send(const AValue: TCastleStringList); overload; |
This item has no description. |
Properties
![]() |
property Items: TCastleStringList read FItems write SetItems; |
This item has no description. |
![]() |
property ItemsSafe[Index: Integer]: string read GetItemsSafe write SetItemsSafe; |
This item has no description. |
Generated by PasDoc 0.16.0-snapshot.