Back to class index
Plane[Class Summary]
normal
d
ctor (+6 overloads)
Set(v1,v2,v3) (+1 overload)
ReverseNormal()
PointOnPlane()[const]
Transform(transform) (+3 overloads)
IsInPositiveDirection(directionVector)[const]
IsOnPositiveSide(point)[const]
ExamineSide(triangle)[const]
AreOnSameSide(p1,p2)[const]
Distance(point)[const] (+3 overloads)
SignedDistance(point)[const]
OrthoProjection()[const]
Project(point)[const] (+5 overloads)
ObliqueProjection(...)[const]
ObliqueProject(...)[const]
MirrorMatrix()[const]
Mirror(point)[const]
Refract(...)[const]
ClosestPoint(point)[const] (+2 overloads)
Contains(point,epsilon)[const] (+6 overloads)
SetEquals(plane,epsilon)[const]
Equals(other,epsilon)[const]
IsParallel(plane,epsilon)[const]
DihedralAngle(plane)[const]
Intersects(...)[const] (+14 overloads)
Clip(line)[const] (+3 overloads)
PassesThroughOrigin(epsilon)[const]
GenerateCircle(...)[const]

Plane::Contains

Syntax

bool Plane::Contains(const float3 &point, float epsilon=1e-3f) const; [4 lines of code]
bool Plane::Contains(const Line &line, float epsilon=1e-3f) const; [4 lines of code]
bool Plane::Contains(const Ray &ray, float epsilon=1e-3f) const; [4 lines of code]
bool Plane::Contains(const LineSegment &lineSegment, float epsilon=1e-3f) const; [4 lines of code]
bool Plane::Contains(const Triangle &triangle, float epsilon=1e-3f) const; [4 lines of code]
bool Plane::Contains(const Circle &circle, float epsilon=1e-3f) const; [4 lines of code]
bool Plane::Contains(const Polygon &polygon, float epsilon=1e-3f) const; [11 lines of code]

Tests if this plane contains the given object.

Parameters

floatepsilonSince a plane is a 2D object in a 3D space, an distance threshold is used for the test. This value gives a "thickness" to this plane for the purposes of the test.

Return Value

True if the given object is contained in this plane, up to the given epsilon distance.

Performance

bool Plane::Contains(const float3 &point, float epsilon=1e-3f) const

4.105nsecs/call ≈ 243.59M calls/second ≈ 4.06M calls/frame (@ 60fps).
This function does not perform dynamic memory allocation.

bool Plane::Contains(const Line &line, float epsilon=1e-3f) const

4.105nsecs/call ≈ 243.59M calls/second ≈ 4.06M calls/frame (@ 60fps).
This function does not perform dynamic memory allocation.

bool Plane::Contains(const Ray &ray, float epsilon=1e-3f) const

4.105nsecs/call ≈ 243.59M calls/second ≈ 4.06M calls/frame (@ 60fps).
This function does not perform dynamic memory allocation.

bool Plane::Contains(const LineSegment &lineSegment, float epsilon=1e-3f) const

4.105nsecs/call ≈ 243.59M calls/second ≈ 4.06M calls/frame (@ 60fps).
This function does not perform dynamic memory allocation.

bool Plane::Contains(const Triangle &triangle, float epsilon=1e-3f) const

4.105nsecs/call ≈ 243.59M calls/second ≈ 4.06M calls/frame (@ 60fps).
This function does not perform dynamic memory allocation.

bool Plane::Contains(const Circle &circle, float epsilon=1e-3f) const

4.105nsecs/call ≈ 243.59M calls/second ≈ 4.06M calls/frame (@ 60fps).
This function does not perform dynamic memory allocation.

bool Plane::Contains(const Polygon &polygon, float epsilon=1e-3f) const

4.105nsecs/call ≈ 243.59M calls/second ≈ 4.06M calls/frame (@ 60fps).
This function allocates 8 bytes (1 blocks) of temporary work memory.

Leave a Comment

Name:
Comments:
Captcha:captcha image Type in the black symbols:
Back to class index