tie.h

Go to the documentation of this file.

/*                           T I E . H
 * BRL-CAD
 *
 * Copyright (c) 2008-2024 United States Government as represented by
 * the U.S. Army Research Laboratory.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this file; see the file named COPYING for more
 * information.
 */
/** @file tie.h
 *
 *
 */
 
#ifndef RT_TIE_H
#define RT_TIE_H
 
#include "common.h"
 
#include "vmath.h"
 
__BEGIN_DECLS
 
#ifndef RT_EXPORT
#  if defined(RT_DLL_EXPORTS) && defined(RT_DLL_IMPORTS)
#    error "Only RT_DLL_EXPORTS or RT_DLL_IMPORTS can be defined, not both."
#  elif defined(RT_DLL_EXPORTS)
#    define RT_EXPORT COMPILER_DLLEXPORT
#  elif defined(RT_DLL_IMPORTS)
#    define RT_EXPORT COMPILER_DLLIMPORT
#  else
#    define RT_EXPORT
#  endif
#endif
 
/*
 * define which precision to use, 0 is 'float' and 1 is 'double'.
 * Horrible macros wrap functions and values to build a library
 * capable of doing either without recompilation.
 */
#ifndef TIE_PRECISION
#  define TIE_PRECISION 1
#endif
 
#define TIE_CHECK_DEGENERATE    1
 
#define TIE_KDTREE_FAST         0x0
#define TIE_KDTREE_OPTIMAL      0x1
 
/* Type to use for floating precision */
#if TIE_PRECISION == 0
typedef float TFLOAT;
#  define TIE_VAL(x) CPP_GLUE(x, _single)
#elif TIE_PRECISION == 1
typedef double TFLOAT;
#  define TIE_VAL(x) CPP_GLUE(x, _double)
#else
#  error "Unknown precision"
#endif
 
 
/* TCOPY(type, source base, source offset, dest base, dest offset) */
#define TCOPY(_t, _fv, _fi, _tv, _ti) { \
        *(_t *)&((uint8_t *)_tv)[_ti] = *(_t *)&((uint8_t *)_fv)[_fi]; }
 
typedef struct TIE_3_s {
    TFLOAT v[3];        /* 12-bytes or 24-bytes */
} TIE_3;
 
struct tie_ray_s {
    point_t pos;        /* 24-bytes, Position */
    vect_t dir;         /* 24-bytes, Direction */
    short depth;        /* 2-bytes, Depth */
    short kdtree_depth; /* 2-bytes */
};
 
struct tie_id_s {
    point_t pos;        /* 24-bytes, Point */
    vect_t norm;        /* 24-bytes, Normal */
    fastf_t dist;       /* 8-bytes, Distance */
    fastf_t alpha;      /* 8-bytes, Barycentric Coordinate Alpha */
    fastf_t beta;       /* 8-bytes, Barycentric Coordinate Beta */
};
 
struct tie_tri_s {
    TIE_3 data[3];      /* 12*3=36-bytes or 24*3=72-bytes,
                         *
                         * Data[0] = Point,
                         * Data[1] = Normal,
                         * Data[2] = DotProduct, VectorU, VectorV
                         */
    TFLOAT v[2];        /* 8-bytes or 16-bytes */
    void *ptr;          /* 4-bytes or 8-bytes */
    uint32_t b;         /* 4-bytes (way more than we need, but helps keep alignment) */
};
 
struct tie_kdtree_s {
    float axis; /* 4-bytes, intentionally float */
    uint32_t b; /* 4-bytes, bit array to store data about the kdtree node */
    void *data; /* 4-bytes or 8-bytes */
};
 
 
struct tie_s {
    uint64_t rays_fired;
    struct tie_kdtree_s *kdtree;
    unsigned int max_depth;     /* Maximum depth allowed for given geometry */
    unsigned int tri_num;
    unsigned int tri_num_alloc;
    struct tie_tri_s *tri_list;
    int stat;                   /* used for testing various statistics */
    unsigned int kdmethod;      /* Optimal or Fast */
    point_t min, max;
    vect_t amin, amax, mid;
    fastf_t radius;
};
 
RT_EXPORT extern int tie_check_degenerate;
RT_EXPORT extern fastf_t TIE_PREC;
 
#define TIE_INIT TIE_VAL(tie_init)
#define TIE_FREE TIE_VAL(tie_free)
#define TIE_PREP TIE_VAL(tie_prep)
#define TIE_WORK TIE_VAL(tie_work)
#define TIE_PUSH TIE_VAL(tie_push)
#define TIE_KDTREE_PREP TIE_VAL(tie_kdtree_prep)
#define TIE_KDTREE_FREE TIE_VAL(tie_kdtree_free)
 
RT_EXPORT extern void TIE_INIT(struct tie_s *tie, unsigned int tri_num, unsigned int kdmethod);
RT_EXPORT extern void TIE_FREE(struct tie_s *tie);
RT_EXPORT extern void TIE_PREP(struct tie_s *tie);
RT_EXPORT extern void*TIE_WORK(struct tie_s *tie, struct tie_ray_s *ray, struct tie_id_s *id, void *(*hitfunc)(struct tie_ray_s*, struct tie_id_s*, struct tie_tri_s*, void *ptr), void *ptr);
RT_EXPORT extern void TIE_PUSH(struct tie_s *tie, TIE_3 **tlist, unsigned int tnum, void *plist, unsigned int pstride);
RT_EXPORT extern void TIE_KDTREE_FREE(struct tie_s *tie);
RT_EXPORT extern void TIE_KDTREE_PREP(struct tie_s *tie);
 
__END_DECLS
 
#endif /* RT_TIE_H */
 
/*
 * Local Variables:
 * tab-width: 8
 * mode: C
 * indent-tabs-mode: t
 * c-file-style: "stroustrup"
 * End:
 * ex: shiftwidth=4 tabstop=8
 */