Class TTogglerNode

Unit

Declaration

type TTogglerNode = class(TAbstractChildNode)

Description

Utility for setting and observing a boolean value in various ways.

Hierarchy

Overview

Methods

Public constructor Create(const AX3DName: string = ''; const ABaseUrl: string = ''); override;
Public procedure CreateNode; override;
Public class function ClassX3DType: string; override;

Properties

Public property FdStatus: TSFBool read FFdStatus;
Public property Status: Boolean read GetStatus write SetStatus;
Public property FdNotStatus: TSFBool read FFdNotStatus;
Public property NotStatus: Boolean read GetNotStatus write SetNotStatus;
Public property EventToggle: TXFAnyEvent read FEventToggle;
Public property EventSet: TXFAnyEvent read FEventSet;
Public property EventReset: TXFAnyEvent read FEventReset;
Public property EventChanged: TSFBoolEvent read FEventChanged;
Public property EventOn: TSFBoolEvent read FEventOn;
Public property EventOff: TSFBoolEvent read FEventOff;
Public property FdEnabled: TSFBool read FFdEnabled;
Public property Enabled: Boolean read GetEnabled write SetEnabled;

Description

Methods

Public constructor Create(const AX3DName: string = ''; const ABaseUrl: string = ''); override;

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

Constructor. Initializes various properties:

  • Name, BaseUrl are initialized from given parameters.

  • The Fields, Events lists are filled in every descendant, to have all the fields/events defined by the specification.

  • DefaultContainerField, and other node-specific stuff, is filled in descendants. This is actually implemented in CreateNode, that is called at the end of this constructor.

Public procedure CreateNode; override;

This item has no description. Showing description inherited from TAbstractChildNode.CreateNode.

Automatically generated node properties.

Do not edit this file manually! To add new properties: - add them to the text files in tools/internal/x3d-nodes-to-pascal/nodes-specification/ , - and regenerate include files by running x3d-nodes-to-pascal

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.

Properties

Public property FdStatus: TSFBool read FFdStatus;

Internal wrapper for property Status. This wrapper API may change, we advise to access simpler Status instead.

Public property Status: Boolean read GetStatus write SetStatus;

Stored Boolean value.

Public property FdNotStatus: TSFBool read FFdNotStatus;

Internal wrapper for property NotStatus. This wrapper API may change, we advise to access simpler NotStatus instead.

Public property NotStatus: Boolean read GetNotStatus write SetNotStatus;

Always the negated value of Status. You can set either Status or NotStatus, changing one changes also the other to keep them being negated values of each other. Also events (like EventToggle) change both properties.

Public property EventToggle: TXFAnyEvent read FEventToggle;

Send any value to this event (the value is ignored) to toggle Status between True and False.

Public property EventSet: TXFAnyEvent read FEventSet;

Send any value to this event (the value is ignored) to set Status to True.

Public property EventReset: TXFAnyEvent read FEventReset;

Send any value to this event (the value is ignored) to set Status to False.

Public property EventChanged: TSFBoolEvent read FEventChanged;

Outputs a True value whenever the Status changed.

Public property EventOn: TSFBoolEvent read FEventOn;

Outputs a True value whenever the Status changed to True.

Public property EventOff: TSFBoolEvent read FEventOff;

Outputs a True value whenever the Status changed to False.

Public property FdEnabled: TSFBool read FFdEnabled;

Internal wrapper for property Enabled. This wrapper API may change, we advise to access simpler Enabled instead.

Public property Enabled: Boolean read GetEnabled write SetEnabled;

When the node is disabled, input events are ignored (this includes EventToggle, EventSet, EventReset but also sending new values to Status and NotStatus) and output events (EventOn, EventOff, EventChanged) are never generated.


Generated by PasDoc 0.16.0.