API Reference

Class TSoundNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TSoundNode = class(TAbstractSoundNode)

Description

3D sound emitter.

Hierarchy

Overview

Methods

Protected procedure BeforeTraverse(StateStack: TX3DGraphTraverseStateStack); override;
Protected function DirectEnumerateActive(Func: TEnumerateChildrenFunction): Pointer; override;
Public constructor Create(const AX3DName: string = ''; const ABaseUrl: String = ''); override;
Public destructor Destroy; override;
Public procedure CreateNode; override;
Public class function ClassX3DType: String; override;

Properties

Public property FdDirection: TSFVec3f read FFdDirection;
Public property Direction: TVector3 read GetDirection write SetDirection;
Public property FdIntensity: TSFFloat read FFdIntensity;
Public property Intensity: Single read GetIntensity write SetIntensity;
Public property FdLocation: TSFVec3f read FFdLocation;
Public property Location: TVector3 read GetLocation write SetLocation;
Public property FdMaxBack: TSFFloat read FFdMaxBack;
Public property MaxBack: Single read GetMaxBack write SetMaxBack;
Public property FdMaxFront: TSFFloat read FFdMaxFront;
Public property MaxFront: Single read GetMaxFront write SetMaxFront;
Public property FdMinBack: TSFFloat read FFdMinBack;
Public property MinBack: Single read GetMinBack write SetMinBack;
Public property FdMinFront: TSFFloat read FFdMinFront;
Public property MinFront: Single read GetMinFront write SetMinFront;
Public property FdPriority: TSFFloat read FFdPriority;
Public property Priority: Single read GetPriority write SetPriority;
Public property FdSource: TSFNode read FFdSource;
Public property Source: TX3DNode read GetSource write SetSource;
Public property FdSpatialize: TSFBool read FFdSpatialize;
Public property Spatialize: Boolean read GetSpatialize write SetSpatialize;

Description

Methods

Protected procedure BeforeTraverse(StateStack: TX3DGraphTraverseStateStack); override;

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

Override these methods to determine what happens when given node is traversed during Traverse call. The main use of this is to operate on TX3DGraphTraverseStateStack.

Remember to always call inherited when overriding. In BeforeTraverse and MiddleTraverse you should call inherited at the beginning, in AfterTraverse inherited should be called at the end.

Besides changing StateStack.Top fields, you can do push/pop on the stack. Remember that if you do StateStack.Push in BeforeTraverse, and then you must call StateStack.Pop in AfterTraverse.

Protected function DirectEnumerateActive(Func: TEnumerateChildrenFunction): Pointer; override;

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

Enumerate all active child nodes of given node.

"Active nodes" are the ones affecting current look or collisions, e.g. from Switch node only one child will be enumerated. See Traverse for more precise definition.

"Direct" means that this enumerates only direct descendants, i.e. this is not recursive. See methods like Traverse or EnumerateNodes if you want recursive behavior.

This can enumerate both VRML1Children nodes and nodes within TSFNode and TMFNode fields.

Default implementation in this class enumerates all Children nodes of VRML 1.0. If you need to remove some children for VRML 1.0 (e.g. for Switch or LOD nodes) or add some children for VRML 2.0 you have to override this. You do not need to call inherited when overriding this — in fact, you should not, if you want to omit some nodes.

Stops and returns immediately if Func returns non-nil for some child.

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 destructor Destroy; override;

This item has no description.

Public procedure CreateNode; override;

Create node fields and events.

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 FdDirection: TSFVec3f read FFdDirection;

Internal wrapper for property Direction. This wrapper API may change, we advise to access simpler Direction instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Direction: TVector3 read GetDirection write SetDirection;

This item has no description.

Public property FdIntensity: TSFFloat read FFdIntensity;

Internal wrapper for property Intensity. This wrapper API may change, we advise to access simpler Intensity instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Intensity: Single read GetIntensity write SetIntensity;

This item has no description.

Public property FdLocation: TSFVec3f read FFdLocation;

Internal wrapper for property Location. This wrapper API may change, we advise to access simpler Location instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Location: TVector3 read GetLocation write SetLocation;

This item has no description.

Public property FdMaxBack: TSFFloat read FFdMaxBack;

Internal wrapper for property MaxBack. This wrapper API may change, we advise to access simpler MaxBack instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property MaxBack: Single read GetMaxBack write SetMaxBack;

This item has no description.

Public property FdMaxFront: TSFFloat read FFdMaxFront;

Internal wrapper for property MaxFront. This wrapper API may change, we advise to access simpler MaxFront instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property MaxFront: Single read GetMaxFront write SetMaxFront;

This item has no description.

Public property FdMinBack: TSFFloat read FFdMinBack;

Internal wrapper for property MinBack. This wrapper API may change, we advise to access simpler MinBack instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property MinBack: Single read GetMinBack write SetMinBack;

This item has no description.

Public property FdMinFront: TSFFloat read FFdMinFront;

Internal wrapper for property MinFront. This wrapper API may change, we advise to access simpler MinFront instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property MinFront: Single read GetMinFront write SetMinFront;

This item has no description.

Public property FdPriority: TSFFloat read FFdPriority;

Internal wrapper for property Priority. This wrapper API may change, we advise to access simpler Priority instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Priority: Single read GetPriority write SetPriority;

This item has no description.

Public property FdSource: TSFNode read FFdSource;

Internal wrapper for property Source. This wrapper API may change, we advise to access simpler Source instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Source: TX3DNode read GetSource write SetSource;

This item has no description.

Public property FdSpatialize: TSFBool read FFdSpatialize;

Internal wrapper for property Spatialize. This wrapper API may change, we advise to access simpler Spatialize instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Spatialize: Boolean read GetSpatialize write SetSpatialize;

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.