Class TSFFloat
Unit
Declaration
type TSFFloat = class(TX3DSingleField)
Description
X3D field containing a floating-point value with Single precision.
Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 167).
Hierarchy
- TObject
- TPersistent
- TX3DFileItem
- TX3DFieldOrEvent
- TX3DField
- TX3DSingleField
- TSFFloat
Overview
Fields
| Public | DefaultValue: Single; |
| Public | DefaultValueExists: boolean; |
Methods
| Public | constructor Create(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: String; const AValue: Single); |
| Public | procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); override; |
| Public | function EqualsDefaultValue: boolean; override; |
| Public | function Equals(SecondValue: TX3DField): boolean; override; |
| Public | function FastEqualsValue(SecondValue: TX3DField): boolean; override; |
| Public | procedure AssignLerp(const A: Double; Value1, Value2: TX3DField); override; |
| Public | function CanAssignLerp: boolean; override; |
| Public | procedure Assign(Source: TPersistent); override; |
| Public | procedure AssignValue(Source: TX3DField); override; |
| Public | procedure AssignDefaultValueFromValue; override; |
| Public | procedure UnassignDefaultValue; override; |
| Public | class function X3DType: String; override; |
| Public | class function CreateEvent(const AParentNode: TX3DFileItem; const AName: String; const AInEvent: boolean): TX3DEvent; override; |
| Public | procedure Send(const AValue: Single); overload; |
Properties
| Public | property Value: Single read FValue write SetValue; |
| Public | property MustBeNonnegative: Boolean
read FMustBeNonnegative write SetMustBeNonnegative default false; |
| Public | property Angle: boolean read FAngle write FAngle default false; |
Description
Fields
| Public | DefaultValue: Single; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 177). | |
| Public | DefaultValueExists: boolean; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 178). | |
Methods
| Public | constructor Create(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: String; const AValue: Single); |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 180). | |
| Public | procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); override; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 199). | |
| Public | function EqualsDefaultValue: boolean; override; |
|
This item has no description. Showing description inherited from TX3DField.EqualsDefaultValue.
Whether the value is equal to default. Returns always Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 201). | |
| Public | 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). Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 202). | |
| Public | 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 ( Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 203). | |
| Public | procedure AssignLerp(const A: Double; Value1, Value2: TX3DField); override; |
|
This item has no description. Showing description inherited from TX3DField.AssignLerp. Assigns value to this node calculated from linear interpolation between two given nodes Value1, Value2. Just like other lerp functions in our units (like CastleVectors.Lerp). Like AssignValue, this copies only the current value. All other properties (like Name, IsClauseNames, ValueFromIsClause, default value) are untouched. There are some special precautions for this:
Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 205). | |
| Public | function CanAssignLerp: boolean; override; |
|
This item has no description. Showing description inherited from TX3DField.CanAssignLerp. Is AssignLerp usable on this field type? Descendants implementors notes: In this class, this always returns Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 206). | |
| Public | procedure Assign(Source: TPersistent); override; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 207). | |
| Public | 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); Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 208). | |
| Public | 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 Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 209). | |
| Public | 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 Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 210). | |
| Public | class function X3DType: String; override; |
|
This item has no description. Showing description inherited from TX3DField.X3DType.
Field type in X3D, like Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 212). | |
| Public | 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. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 213). | |
| Public | procedure Send(const AValue: Single); overload; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 215). | |
Properties
| Public | property Value: Single read FValue write SetValue; |
|
Current field value. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 184). | |
| Public | property MustBeNonnegative: Boolean
read FMustBeNonnegative write SetMustBeNonnegative default false; |
|
Set this to Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 191). | |
| Public | property Angle: boolean read FAngle write FAngle default false; |
|
Value represents an angle. When reading from X3D 3.3 file, we will make sure it's expressed in radians, honoring optional "UNIT angle ..." declaration in X3D file. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 197). | |
Generated by PasDoc 0.17.0.snapshot.