Skip to content

BH.oM.Humans.ViewQuality.AvalueSettings

Class structure

Implemented interfaces and base types

The AvalueSettings is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
EffectiveConeOfVision Polyline Reference Cone of Vision used for all Spectators. This is equivalent to the curve generated from the intersection of the near clipping plane and the viewing frustum.It should be planar and closed and in a plane parallel to the global XY Plane.Default value is a square based frustum with 30 degree field of view and near clipping plane 0.1 from the eye reference location. Giving a a 0.115 * 0.115 square EffectiveConeOfVision. -
FarClippingPlaneDistance double The distance from a spectator to the far clipping plane of their view frustum. Spectators in front of this plane will not be used in the occlusion part of the Avalue calculation. Default value is 1. -
CalculateOcclusion bool Calculate proportion of playing area obstructed by heads of Spectators in front. Default value is false -
EffectiveConeOfVisionWidth double Width of default EffectiveConeOfVision. Default value is 0.115. Used only when no EffectiveConeOfVision is provided. -
EffectiveConeOfVisionHeight double Height of default EffectiveConeOfVision. Default value is 0.115. Used only when no EffectiveConeOfVision is provided. -
NearClippingPlaneDistance double The distance from a spectator to the near clipping plane of their view frustum. Default value is 0.1. Used only when no EffectiveConeOfVision is provided. -
FocalPoint Point Optional focal point to set the view direction of the spectators. If none provided the Avalue is calculated using the neutral viewing direction of each spectator. -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
BHoM_Guid Guid - -
Name string - -
Fragments FragmentSet - -
Tags HashSet<string> - -
CustomData Dictionary<string, object> - -

Code and Schema

C# implementation

C#
public class AvalueSettings : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject

Assembly: Humans_oM.dll

The C# class definition is available on github:

All history and changes of the class can be found by inspection the history.

JSON Schema implementation

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema
{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Humans_oM/ViewQuality/AvalueSettings.json"
}

The JSON Schema is available on github here: