Class TSFImage

Unit

Declaration

type TSFImage = class(TX3DSingleField)

Description

X3D field containing an image that is "embedded" in the X3D file.

Hierarchy

Overview

Methods

Public constructor Create(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: string; const AValue: TCastleImage);
Public constructor CreateUndefined(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: string); override;
Public destructor Destroy; override;
Public procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); 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;
Public class function CreateEvent(const AParentNode: TX3DFileItem; const AName: string; const AInEvent: boolean): TX3DEvent; override;

Properties

Public property Value: TCastleImage read FValue write SetValue;

Description

Methods

Public constructor Create(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: string; const AValue: TCastleImage);
 
Parameters
AValue
is the initial value for Value.

Note - our constructor COPIES passed reference AValue, not it's contents (I mean, we do Value := AValue, NOT Value := ImageCopy(AValue), so don't Free image given to us (at least, don't do this without clearing our Value field)). You can pass AValue = nil, then Value will be initialized to null image TRGBImage.Create.

Public constructor CreateUndefined(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: string); override;
 
Public destructor Destroy; override;
 
Public procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); 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;
 
Public class function CreateEvent(const AParentNode: TX3DFileItem; const AName: string; const AInEvent: boolean): TX3DEvent; override;
 

Properties

Public property Value: TCastleImage read FValue write SetValue;

Current image, expressed as the TCastleImage instance.

The image instance is by default owned by this object, which means that we will free it in destructor or when setting another value.

Value may be IsEmpty, and then we know that there is no image recorded in this field. Value may never be Nil.


Generated by PasDoc 0.16.0.