API Reference

Class TBorder

Description
Hierarchy
Fields
Methods
Properties

Unit

CastleVectors

Declaration

type TBorder = class(TCastleComponent)

Description

Configurable border size for TCastleUserInterface.Border.

Hierarchy

Overview

Fields

Public OnChange: TNotifyEvent;

Methods

Public procedure Assign(Source: TPersistent); override;
Public function ValueIsStreamed: Boolean; override;
Public function ToString: String; override;
Public function PropertySections(const PropertyName: String): TPropertySections; override;
Public function TotalTop: Single;
Public function TotalRight: Single;
Public function TotalBottom: Single;
Public function TotalLeft: Single;
Public function TotalWidth: Single;
Public function TotalHeight: Single;
Public function Exists: Boolean;

Properties

Published property Top: Single read FTop write SetTop default 0 ;
Published property Right: Single read FRight write SetRight default 0 ;
Published property Bottom: Single read FBottom write SetBottom default 0 ;
Published property Left: Single read FLeft write SetLeft default 0 ;
Published property AllSides: Single read FAllSides write SetAllSides default 0 ;

Description

Fields

Public OnChange: TNotifyEvent;

This item has no description.

Methods

Public procedure Assign(Source: TPersistent); override;

This item has no description.

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

Public function ToString: String; override;

This item has no description.

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

Public function TotalTop: Single;

Total top border (Top + AllSides).

Public function TotalRight: Single;

Total right border (Right + AllSides).

Public function TotalBottom: Single;

Total bottom border (Bottom + AllSides).

Public function TotalLeft: Single;

Total left border (Left + AllSides).

Public function TotalWidth: Single;

Total horizontal border (TotalLeft + TotalRight).

Public function TotalHeight: Single;

Total vertical border (TotalTop + TotalBottom).

Public function Exists: Boolean;

Anything not zero?

Properties

Published property Top: Single read FTop write SetTop default 0 ;

This item has no description.

Published property Right: Single read FRight write SetRight default 0 ;

This item has no description.

Published property Bottom: Single read FBottom write SetBottom default 0 ;

This item has no description.

Published property Left: Single read FLeft write SetLeft default 0 ;

This item has no description.

Published property AllSides: Single read FAllSides write SetAllSides default 0 ;

This item has no description.

Generated by PasDoc 0.16.0-snapshot.

Copyright Michalis Kamburelis and Castle Game Engine Contributors.

This webpage is also open-source and we welcome pull requests to improve it.

We use cookies for analytics. See our privacy policy.