Class TCastleColorRGBPersistent

Description

Hierarchy

Fields

Methods

Properties

Unit

CastleColors

Declaration

type TCastleColorRGBPersistent = class(TCastleComponent)

Description

TCastleColorRGB record represented as a TPersistent descendant, to be able to visually edit it (in Lazarus and Delphi visual designer, and Castle Game Engine visual designer) and to serialize it.

Normal user code does not need to deal with this class or it's instances. Instead directly operate on TCastleColorRGB values, which is faster and more natural. TCastleColorRGB are simple records, so they are naturally copied on assignment, and various operators like additions work in a natural way too.

Source: src/base/castlecolors_persistent.inc (line 32).

Hierarchy

TObject
TPersistent
TComponent
TCastleComponent
TCastleColorRGBPersistent

Overview

Fields

	`InternalGetValue: TGetVector3Event;`
	`InternalSetValue: TSetVector3Event;`
	`InternalDefaultValue: TCastleColorRGB;`

Methods

	`procedure Loaded; override;`
	`constructor Create(const AOwner: TComponent = nil); reintroduce;`
	`function ValueIsStreamed: Boolean; override;`
	`function PropertySections(const PropertyName: String): TPropertySections; override;`
	`function ToString: String; override;`

Properties

	`property Value: TCastleColorRGB read GetValue write SetValue;`
	`property Red: Single read GetRed write SetRed stored RedIsStored nodefault;`
	`property Green: Single read GetGreen write SetGreen stored GreenIsStored nodefault;`
	`property Blue: Single read GetBlue write SetBlue stored BlueIsStored nodefault;`

Description

Fields

InternalGetValue: TGetVector3Event;

This item has no description.

Source: src/base/castlecolors_persistent.inc (line 58).

InternalSetValue: TSetVector3Event;

This item has no description.

Source: src/base/castlecolors_persistent.inc (line 59).

InternalDefaultValue: TCastleColorRGB;

This item has no description.

Source: src/base/castlecolors_persistent.inc (line 60).

Methods

procedure Loaded; override;

This item has no description.

Source: src/base/castlecolors_persistent.inc (line 56).

constructor Create(const AOwner: TComponent = nil); reintroduce;

This item has no description.

Source: src/base/castlecolors_persistent.inc (line 61).

function ValueIsStreamed: Boolean; override;

This item has no description. Showing description inherited from TCastleComponent.ValueIsStreamed.

Whether the current value of this object should be written to the stream. This should be True if anything inside this object should be serialized (which means it has non-default value or "stored" specifier indicates that it should be serialized).

This is used by CastleComponentSerialize, which is used in Castle Game Engine for all serialization.

In simple cases, this just says whether the current value of this object equals to some default value.

The default implementation of this class returns True (so always write).

Descendants that override this to sometimes return False (so no need to write) must be very careful: any addition of a new field requires extending this method, otherwise new field may not be saved sometimes (when all other fields are default). Descentants of such classes must also be aware of it. This check must include everything that is inside this object in JSON, including subcomponents and children objects (as done e.g. by TSerializationProcess.ReadWriteList). In practice, overriding this method is only reasonable for simple classes that will not change much in the future, like TCastleVector3Persistent.

The name of this method is consistent with TPropertyEditor.ValueIsStreamed in LCL.

Source: src/base/castlecolors_persistent.inc (line 63).

function PropertySections(const PropertyName: String): TPropertySections; override;

This item has no description. Showing description inherited from TCastleComponent.PropertySections.

Section where to show property in the editor.

Source: src/base/castlecolors_persistent.inc (line 64).

function ToString: String; override;

This item has no description.

Source: src/base/castlecolors_persistent.inc (line 65).