PhysicsRayQueryParameters2D

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.PhysicsRayQueryParameters2D
Namespace	Electron2D
Kind	class
Category	Physics

Overview

Stores parameters for Electron2D.PhysicsDirectSpaceState2D.IntersectRay(Electron2D.PhysicsRayQueryParameters2D).

Syntax

public sealed class Electron2D.PhysicsRayQueryParameters2D : Electron2D.RefCounted

Remarks

This type is part of the Electron2D 0.1.0 Preview public API.

Thread Safety

This type is not synchronized. Mutate it on the main scene thread.

Since

This type is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
CollideWithAreas	Property	Gets or sets whether area objects are included.
CollideWithBodies	Property	Gets or sets whether body objects are included.
CollisionMask	Property	Gets or sets the collision layers scanned by this query.
Exclude	Property	Gets or sets RIDs excluded from the query.
From	Property	Gets or sets the ray start point in world coordinates.
HitFromInside	Property	Gets or sets whether a ray starting inside a shape reports a hit.
To	Property	Gets or sets the ray end point in world coordinates.
Electron2D.PhysicsRayQueryParameters2D()	Constructor	Initializes a new instance of the PhysicsRayQueryParameters2D type.

Member Details

CollideWithAreas

Kind: Property

public System.Boolean CollideWithAreas { get; set; }

Summary

Gets or sets whether area objects are included.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current collide with areas value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsRayQueryParameters2D

CollideWithBodies

Kind: Property

public System.Boolean CollideWithBodies { get; set; }

Summary

Gets or sets whether body objects are included.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current collide with bodies value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsRayQueryParameters2D

CollisionMask

Kind: Property

public System.UInt32 CollisionMask { get; set; }

Summary

Gets or sets the collision layers scanned by this query.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current collision mask value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsRayQueryParameters2D

Exclude

Kind: Property

public Electron2D.Rid[] Exclude { get; set; }

Summary

Gets or sets RIDs excluded from the query.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current exclude value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsRayQueryParameters2D

From

Kind: Property

public Electron2D.Vector2 From { get; set; }

Summary

Gets or sets the ray start point in world coordinates.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current from value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsRayQueryParameters2D

HitFromInside

Kind: Property

public System.Boolean HitFromInside { get; set; }

Summary

Gets or sets whether a ray starting inside a shape reports a hit.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current hit from inside value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsRayQueryParameters2D

To

Kind: Property

public Electron2D.Vector2 To { get; set; }

Summary

Gets or sets the ray end point in world coordinates.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current to value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsRayQueryParameters2D

Electron2D.PhysicsRayQueryParameters2D()

Kind: Constructor

public Electron2D.PhysicsRayQueryParameters2D()

Summary

Initializes a new instance of the PhysicsRayQueryParameters2D type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsRayQueryParameters2D