SurfaceGeometry Namespace Reference

Classes
struct	RayDirectionOptions
	Ray-direction intent for AdaptiveRayContainmentCheck: an explicit mode plus the direction to use when mode == USER_SPECIFIED (ignored for AUTO_PCA). More...

Enumerations
enum class	RayDirectionMode { AUTO_PCA , USER_SPECIFIED }
	How the ray-casting engine obtains its shooting direction. More...
enum class	SurfaceSide { INSIDE , OUTSIDE , ON }
	The side of a closed surface where a query point is located. More...

Functions
SurfaceSide	signedValueSideness (Real phi, Real tolerance, bool inside_is_negative)
	Classify a signed level-set value into a SurfaceSide.
SurfaceSide	unionSideness (SurfaceSide a, SurfaceSide b)
	Combine two classifications for a union: INSIDE if either is INSIDE, otherwise ON if either is ON, otherwise OUTSIDE (the INSIDE > ON > OUTSIDE precedence).
std::ostream &	operator<< (std::ostream &os, const SurfaceSide &side)
	Stream a human-readable name for a SurfaceSide value.

Enumeration Type Documentation

RayDirectionMode

enum class SurfaceGeometry::RayDirectionMode

strong

How the ray-casting engine obtains its shooting direction.

Enumerator
AUTO_PCA	The engine auto-selects a robust direction via PCA (may use a fallback).
USER_SPECIFIED	The engine uses the caller-supplied direction exactly, with no auto-selection.

Definition at line 18 of file RayDirectionOptions.h.

{
  AUTO_PCA,
  USER_SPECIFIED
};

SurfaceSide

enum class SurfaceGeometry::SurfaceSide

strong

The side of a closed surface where a query point is located.

Enumerator
INSIDE	The point lies strictly in the interior of the closed surface.
OUTSIDE	The point lies strictly in the exterior of the closed surface.
ON	The point lies on the surface itself, within tolerance.

Definition at line 20 of file SurfaceSide.h.

{
  INSIDE,
  OUTSIDE,
  ON
};

Function Documentation

operator<<()

std::ostream & SurfaceGeometry::operator<< ( std::ostream &  os, const SurfaceSide &  side  )

inline

Stream a human-readable name for a SurfaceSide value.

Defined for debugging output and so test frameworks (e.g. gtest EXPECT_EQ) report the enumerator name rather than its underlying integer value on failure.

Definition at line 53 of file SurfaceSide.h.

{
  switch (side)
  {
    case SurfaceSide::INSIDE:
      return os << "INSIDE";
    case SurfaceSide::OUTSIDE:
      return os << "OUTSIDE";
    case SurfaceSide::ON:
      return os << "ON";
  }
  return os;
}

signedValueSideness()

SurfaceSide SurfaceGeometry::signedValueSideness	(	Real	phi,
		Real	tolerance,
		bool	inside_is_negative
	)

Classify a signed level-set value into a SurfaceSide.

With the signed-distance convention (inside_is_negative == true) a value below -tolerance is INSIDE, a value within +/-tolerance of zero is ON, and a value above +tolerance is OUTSIDE. Setting inside_is_negative == false flips the sign for a level set that is positive in the interior.

Parameters

phi	The signed function value at the query point.
tolerance	Half-width, in value space, of the on-surface band around zero.
inside_is_negative	Whether negative values denote the interior.

Definition at line 18 of file SurfaceSide.C.

{
  // Normalize so that negative always denotes the interior.
  if (!inside_is_negative)
    phi = -phi;
 
  if (phi < -tolerance)
    return SurfaceSide::INSIDE;
  if (std::abs(phi) <= tolerance)
    return SurfaceSide::ON;
  return SurfaceSide::OUTSIDE;
}

Referenced by PointInSignedFunctionCheckUO::sideness().

unionSideness()

SurfaceSide SurfaceGeometry::unionSideness	(	SurfaceSide	a,
		SurfaceSide	b
	)

Combine two classifications for a union: INSIDE if either is INSIDE, otherwise ON if either is ON, otherwise OUTSIDE (the INSIDE > ON > OUTSIDE precedence).

Definition at line 36 of file SurfaceSide.C.

{
  // Precedence: INSIDE beats ON beats OUTSIDE.
  if (a == SurfaceSide::INSIDE || b == SurfaceSide::INSIDE)
    return SurfaceSide::INSIDE;
  if (a == SurfaceSide::ON || b == SurfaceSide::ON)
    return SurfaceSide::ON;
  return SurfaceSide::OUTSIDE;
}

Referenced by PointInUnionCheckUO::sideness().