Class TSFBitMask

Unit

Declaration

type TSFBitMask = class(TX3DSingleField)

Description

Warning: this symbol is deprecated.

VRML 1.0 (deprecated) field representing a bitmask, where a number of "flags" can be "on" or "off". This is deprecated, as VRML 1.0 is an ancient format now.

Hierarchy

Overview

Methods

Public function FlagsCount: integer;
Public procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); override;
Public function AreAllFlags(value: boolean): boolean;
Public constructor Create(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: string; const AFlagNames: array of string; const ANoneString, AAllString: string; const AFlags: array of boolean);
Public destructor Destroy; override;
Public function Equals(SecondValue: TX3DField): boolean; override;
Public procedure Assign(Source: TPersistent); override;
Public procedure AssignValue(Source: TX3DField); override;
Public class function X3DType: string; override;

Properties

Public property Flags[i: integer]: boolean read GetFlags write SetFlags;
Public property FlagNames[i: integer]: string read GetFlagNames;
Public property AllString: string read fAllString;
Public property NoneString: string read fNoneString;

Description

Methods

Public function FlagsCount: integer;

This item has no description.

Public procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); override;

This item has no description.

Public function AreAllFlags(value: boolean): boolean;

Are all flag values set to True currently.

Public constructor Create(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: string; const AFlagNames: array of string; const ANoneString, AAllString: string; const AFlags: array of boolean);

Constructor.

Remember that arrays AFlagNames and AFlags (AFlags is initial value of Flags) must have equal length. Eventually, AFlags may be longer (excessive items will be ignored).

Public destructor Destroy; override;

This item has no description.

Public function Equals(SecondValue: TX3DField): boolean; override;

This item has no description. Showing description inherited from TX3DField.Equals.

True if the SecondValue object has exactly the same type and properties. For this class, this returns just (SecondValue.Name = Name).

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

Public procedure Assign(Source: TPersistent); override;

This item has no description.

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 False. You can manually change it to True, if this copy indeed was done following "IS" clause.

Descendants implementors notes:

In this class, implementation takes care of setting our ValueFromIsClause to False. In descendants, you should do like

if Source is <appropriate class> then
begin
  inherited;
  Value := Source.value;
end else
  AssignValueRaiseInvalidClass(Source);

Public class function X3DType: string; override;

This item has no description. Showing description inherited from TX3DField.X3DType.

Field type in X3D, like 'SFString' or 'MFInt32'. As for VRML/X3D interface declaration statements. In base TX3DField class, this returns XFAny (name indicating any type, used by instantreality and us).

Properties

Public property Flags[i: integer]: boolean read GetFlags write SetFlags;

Value of this field. You can use Index from the range 0 .. FlagsCount - 1.

Public property FlagNames[i: integer]: string read GetFlagNames;

Names of the flags that can be "on" or "off". Note that this cannot be initialized by CreateUndefined, so you always must initialize this field using the Create overload that takes AFlagNames parameter.

Public property AllString: string read fAllString;

Special strings that will be understood by parser as ALL or NONE bit values. AllString selects all flags, NoneString selects none. AllString may be '' is there's no such string, NoneString should never be '' (otherwise, user could not be able to specify some SFBitMask values — NoneString is the only way to specify 0).

There is usually little sense in using them like "ALL | something" (because it means just "ALL") or "NONE | something" (because it means just "something"). But it's allowed syntactically.

Public property NoneString: string read fNoneString;

This item has no description.


Generated by PasDoc 0.16.0.