Public Member Functions | Static Public Member Functions | List of all members
SolidLocationDetail::FaceIndices Struct Reference

FaceIndices is a triple of integers identifying a face within a solid primitive. More...

#include <CurveDetails.h>

Public Member Functions

 FaceIndices (ptrdiff_t index0, ptrdiff_t index1, ptrdiff_t index2)
 constructor with index pair. More...
 
 FaceIndices ()
 Default constructor (all indices zero) More...
 
void Set (ptrdiff_t index0, ptrdiff_t index1, ptrdiff_t index2)
 Set both indices. More...
 
void SetCap0 ()
 Set both indices as the special start cap indices. More...
 
void SetCap1 ()
 set both indices as the special end cap indices More...
 
ptrdiff_t Index0 () const
 Query the first index. More...
 
ptrdiff_t Index1 () const
 Query the second index. More...
 
ptrdiff_t Index2 () const
 Query the third index. More...
 
void SetIndex0 (ptrdiff_t value)
 Set the first index. More...
 
void SetIndex1 (ptrdiff_t value)
 Set the second index. More...
 
void SetIndex2 (ptrdiff_t value)
 Set the third index. More...
 
bool IsCap0 () const
 Ask if this is the special index pair for start cap. More...
 
bool IsCap1 () const
 Ask if this is the special index pair for end cap. More...
 
bool IsCap () const
 Ask if this is either of the start or end caps. More...
 
bool Is (ptrdiff_t index0, ptrdiff_t index1, ptrdiff_t index2) const
 Ask if the indices match a particular triple;. More...
 
bool Is (ptrdiff_t index0, ptrdiff_t index1) const
 Ask if the indices match a particular pair (index3 ignored) More...
 

Static Public Member Functions

static FaceIndices Cap0 ()
 Return the special (constant) face indices for the start cap of swept primitives. More...
 
static FaceIndices Cap1 ()
 Return the special (constant) face indices for the end cap of swept primitives. More...
 

Detailed Description

FaceIndices is a triple of integers identifying a face within a solid primitive.

Constructor & Destructor Documentation

FaceIndices ( ptrdiff_t  index0,
ptrdiff_t  index1,
ptrdiff_t  index2 
)

constructor with index pair.

Default constructor (all indices zero)

Member Function Documentation

static FaceIndices Cap0 ( )
static

Return the special (constant) face indices for the start cap of swept primitives.

static FaceIndices Cap1 ( )
static

Return the special (constant) face indices for the end cap of swept primitives.

ptrdiff_t Index0 ( ) const

Query the first index.

ptrdiff_t Index1 ( ) const

Query the second index.

ptrdiff_t Index2 ( ) const

Query the third index.

bool Is ( ptrdiff_t  index0,
ptrdiff_t  index1,
ptrdiff_t  index2 
) const

Ask if the indices match a particular triple;.

bool Is ( ptrdiff_t  index0,
ptrdiff_t  index1 
) const

Ask if the indices match a particular pair (index3 ignored)

bool IsCap ( ) const

Ask if this is either of the start or end caps.

bool IsCap0 ( ) const

Ask if this is the special index pair for start cap.

bool IsCap1 ( ) const

Ask if this is the special index pair for end cap.

void Set ( ptrdiff_t  index0,
ptrdiff_t  index1,
ptrdiff_t  index2 
)

Set both indices.

void SetCap0 ( )

Set both indices as the special start cap indices.

void SetCap1 ( )

set both indices as the special end cap indices

void SetIndex0 ( ptrdiff_t  value)

Set the first index.

void SetIndex1 ( ptrdiff_t  value)

Set the second index.

void SetIndex2 ( ptrdiff_t  value)

Set the third index.


The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.