#include <GU_PackedImpl.h>

Inheritance diagram for GU_PackedImpl:

Public Types

typedef fpreal(GU_PackedImpl::*	FloatGetter )(const GU_PrimPacked *) const

typedef void(GU_PackedImpl::*	FloatSetter )(const GU_PrimPacked *, fpreal)

typedef GA_Size(GU_PackedImpl::*	IntGetter )(const GU_PrimPacked *) const

typedef void(GU_PackedImpl::*	IntSetter )(GU_PrimPacked *, GA_Size)

typedef bool(GU_PackedImpl::*	BoolGetter )(const GU_PrimPacked *) const

typedef void(GU_PackedImpl::*	BoolSetter )(GU_PrimPacked *, bool)

typedef const char (GU_PackedImpl::	StringGetter )(const GU_PrimPacked *) const

typedef void(GU_PackedImpl::*	StringSetter )(GU_PrimPacked , const char )

typedef UT_OptionsHolder(GU_PackedImpl::*	DictGetter )(const GU_PrimPacked *) const

typedef void(GU_PackedImpl::*	DictSetter )(GU_PrimPacked *, const UT_OptionsHolder &)

typedef std::string(GU_PackedImpl::*	StdStringGetter )(const GU_PrimPacked *) const

typedef void(GU_PackedImpl::*	StdStringSetter )(GU_PrimPacked *, const std::string &)

typedef UT_StringHolder(GU_PackedImpl::*	StringHolderGetter )(const GU_PrimPacked *) const

typedef void(GU_PackedImpl::*	StringHolderSetter )(GU_PrimPacked *, const UT_StringHolder &)

typedef fpreal(GU_PackedImpl::*	FloatTupleGetter )(const GU_PrimPacked *, exint) const

typedef void(GU_PackedImpl::*	FloatTupleSetter )(GU_PrimPacked *, exint, fpreal)

typedef GA_Size(GU_PackedImpl::*	IntTupleGetter )(const GU_PrimPacked *, exint) const

typedef void(GU_PackedImpl::*	IntTupleSetter )(GU_PrimPacked *, exint, GA_Size)

typedef bool(GU_PackedImpl::*	BoolTupleGetter )(const GU_PrimPacked *, exint) const

typedef void(GU_PackedImpl::*	BoolTupleSetter )(GU_PrimPacked *, exint, bool)

typedef const char (GU_PackedImpl::	StringTupleGetter )(const GU_PrimPacked *, exint) const

typedef void(GU_PackedImpl::*	StringTupleSetter )(GU_PrimPacked , exint, const char )

typedef UT_OptionsHolder(GU_PackedImpl::*	DictTupleGetter )(const GU_PrimPacked *, exint) const

typedef void(GU_PackedImpl::*	DictTupleSetter )(GU_PrimPacked *, exint, const UT_OptionsHolder &)

typedef const std::string &(GU_PackedImpl::*	StdStringTupleGetter )(const GU_PrimPacked *, exint) const

typedef void(GU_PackedImpl::*	StdStringTupleSetter )(GU_PrimPacked *, exint, const std::string &)

typedef const UT_StringHolder &(GU_PackedImpl::*	StringHolderTupleGetter )(const GU_PrimPacked *, exint) const

typedef void(GU_PackedImpl::*	StringHolderTupleSetter )(GU_PrimPacked *, exint, const UT_StringHolder &)

typedef void(GU_PackedImpl::*	F32VectorGetter )(const GU_PrimPacked , fpreal32 , exint) const

typedef void(GU_PackedImpl::*	F32VectorSetter )(GU_PrimPacked , const fpreal32 , exint)

typedef void(GU_PackedImpl::*	F64VectorGetter )(const GU_PrimPacked , fpreal64 , exint) const

typedef void(GU_PackedImpl::*	F64VectorSetter )(GU_PrimPacked , const fpreal64 , exint)

typedef void(GU_PackedImpl::*	I32VectorGetter )(const GU_PrimPacked , int32 , exint) const

typedef void(GU_PackedImpl::*	I32VectorSetter )(GU_PrimPacked , const int32 , exint)

typedef void(GU_PackedImpl::*	I64VectorGetter )(const GU_PrimPacked , int64 , exint) const

typedef void(GU_PackedImpl::*	I64VectorSetter )(GU_PrimPacked , const int64 , exint)

typedef void(GU_PackedImpl::*	BVectorGetter )(const GU_PrimPacked , bool , exint) const

typedef void(GU_PackedImpl::*	BVectorSetter )(GU_PrimPacked , const bool , exint)

typedef void(GU_PackedImpl::*	StringArrayGetter )(const GU_PrimPacked *, UT_StringArray &) const

typedef void(GU_PackedImpl::*	StringArraySetter )(GU_PrimPacked *, const UT_StringArray &)

typedef void(GU_PackedImpl::*	DictArrayGetter )(const GU_PrimPacked *, UT_Array< UT_OptionsHolder > &) const

typedef void(GU_PackedImpl::*	DictArraySetter )(GU_PrimPacked *, const UT_Array< UT_OptionsHolder > &)

Public Member Functions
	GU_PackedImpl ()

virtual	~GU_PackedImpl ()

	GU_PackedImpl (const GU_PackedImpl &src)=default

GU_PackedImpl &	operator= (const GU_PackedImpl &src)=default

virtual GU_PackedFactory *	getFactory () const =0
	Get the factory associated with this procedural. More...

virtual GU_PackedImpl *	copy () const =0
	Create a copy of this resolver. More...

virtual bool	isValid () const =0
	Test whether the deferred load primitive data is valid. More...

virtual void	clearData ()=0

virtual bool	load (GU_PrimPacked *prim, const UT_Options &options, const GA_LoadMap &map)=0
	Give a UT_Options of load data, create resolver data for the primitive. More...

virtual bool	supportsJSONLoad () const

virtual bool	loadFromJSON (GU_PrimPacked *prim, const UT_JSONValueMap &options, const GA_LoadMap &map)

virtual void	update (GU_PrimPacked *prim, const UT_Options &options)=0

virtual bool	saveSharedData (UT_JSONWriter &w, GA_SaveMap &map, GA_GeometryIndex *geo_index) const

virtual bool	loadSharedData (int load_data_type, const GA_SharedLoadData *item)

virtual bool	save (UT_Options &options, const GA_SaveMap &map) const =0
	Copy the resolver data into the UT_Options for saving. More...

virtual bool	loadUnknownToken (const char *token, UT_JSONParser &p, const GA_LoadMap &map)

virtual bool	getBounds (UT_BoundingBox &box) const =0
	Get the bounding box for the geometry (not including transforms) More...

bool	getBoundsCached (UT_BoundingBox &box) const

virtual bool	getVisibleBounds (UT_BoundingBox &box) const

bool	getVisibleBoundsCached (UT_BoundingBox &box) const

virtual bool	getRenderingBounds (UT_BoundingBox &box) const =0

virtual void	getVelocityRange (UT_Vector3 &min, UT_Vector3 &max) const =0

virtual void	getWidthRange (fpreal &wmin, fpreal &wmax) const =0

virtual void	getPrimitiveName (const GU_PrimPacked *prim, UT_WorkBuffer &wbuf) const

virtual bool	getLocalTransform (UT_Matrix4D &m) const

virtual bool	unpackWithContext (GU_Detail &destgdp, GU_PackedContext &context, const GU_PrimPacked *prim) const

bool	unpack (GU_Detail &destgdp, const GU_PrimPacked *prim) const

virtual bool	unpack (GU_Detail &destgdp, const UT_Matrix4D *transform) const =0

virtual bool	unpackWithStyler (GU_Detail &destgdp, STY_StylerGroup &prim_styler_group, const STY_Styler &parent_styler, const GU_PrimPacked *prim) const

virtual void	forceLoad () const

virtual bool	isLoaded () const

virtual bool	unpackUsingPolygons (GU_Detail &destgdp, const GU_PrimPacked *prim) const

virtual GU_ConstDetailHandle	getPackedDetail (GU_PackedContext *context=0) const

bool	pointInstanceTransform () const

bool	intrinsicPointInstanceTransform (const GU_PrimPacked *prim) const

void	setPointInstanceTransform (GU_PrimPacked *prim, bool b)
	Set whether point instancing should be used. More...

virtual int64	getMemoryUsage (bool inclusive) const =0
	Report memory usage (includes all shared memory) More...

virtual void	countMemory (UT_MemoryCounter &counter, bool inclusive) const =0

virtual bool	saveCachedBBox () const

virtual void	setFacesetAttribute (const UT_StringHolder &s)

virtual const UT_StringHolder &	facesetAttribute () const

virtual void	setAttributeNameMap (const GEO_PackedNameMapPtr &m)

virtual const GEO_PackedNameMapPtr &	attributeNameMap () const

virtual void	setSharedNameMapData (GA_SharedDataHandlePtr s)

SYS_FORCE_INLINE bool	isShared () const

SYS_FORCE_INLINE GU_PackedImpl *	copyIfShared ()


int64	intrinsic3Tuple (const GU_PrimPacked *prim) const

int64	intrinsic6Tuple (const GU_PrimPacked *prim) const

int64	intrinsic9Tuple (const GU_PrimPacked *prim) const

int64	intrinsic16Tuple (const GU_PrimPacked *prim) const

std::string	intrinsicPrimitiveName (const GU_PrimPacked *prim) const

const char *	intrinsicFactoryName (const GU_PrimPacked *prim) const

const char *	intrinsicFactoryLabel (const GU_PrimPacked *prim) const

void	intrinsicPackedBox (const GU_PrimPacked prim, fpreal64 vals, exint sz) const

void	intrinsicPackedRenderBox (const GU_PrimPacked prim, fpreal64 vals, exint sz) const

void	intrinsicPivot (const GU_PrimPacked prim, fpreal64 vals, exint sz) const

void	intrinsicSetPivot (GU_PrimPacked prim, const fpreal64 vals, exint sz)

void	intrinsicPrimTransform (const GU_PrimPacked prim, fpreal64 vals, exint sz) const

void	intrinsicSetPrimTransform (GU_PrimPacked prim, const fpreal64 v, exint sz)

void	intrinsicPackedTransform (const GU_PrimPacked prim, fpreal64 v, exint sz) const

void	intrinsicFullTransform (const GU_PrimPacked prim, fpreal64 v, exint sz) const

const char *	intrinsicViewportLOD (const GU_PrimPacked *prim) const

void	intrinsicSetViewportLOD (GU_PrimPacked prim, const char lod)

Public Member Functions inherited from UT_IntrusiveRefCounter< GU_PackedImpl >
SYS_FORCE_INLINE	UT_IntrusiveRefCounter () noexcept
	Default constructor: Sets counter to 0. More...

SYS_FORCE_INLINE	UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &) noexcept
	Copy constructor: Sets counter to 0. More...

UT_IntrusiveRefCounter &	operator= (const UT_IntrusiveRefCounter &) noexcept
	Assignment operator: Does not modify counter. More...

SYS_FORCE_INLINE uint32	use_count () const noexcept
	Return current counter. More...

SYS_FORCE_INLINE bool	conditionalAddRef () noexcept

Static Public Member Functions
static bool	computeVelocityRange (const GU_Detail *gdp, UT_Vector3 &vmin, UT_Vector3 &vmax)

static bool	computeWidthRange (const GU_Detail *gdp, fpreal &wmin, fpreal &wmax)

Protected Member Functions
virtual bool	unpackWithPrim (GU_Detail &destgdp, const UT_Matrix4D transform, const GU_PrimPacked prim) const

const UT_BoundingBox &	boxCache () const

void	setBoxCache (const UT_BoundingBox &b)

template<typename T >
void	setBoxCache (const T b[6])

void	clearBoxCache ()

bool	unpackToDetail (GU_Detail &destgdp, GU_Detail src, const UT_Matrix4D transform) const

bool	unpackToDetail (GU_Detail &destgdp, const GU_Detail src, const UT_Matrix4D transform) const

bool	unpackToDetail (GU_Detail &destgdp, const GU_ConstDetailHandle &gdh, const UT_Matrix4D *transform) const
	Unpack the source detail handle. More...

virtual UT_Vector3	getBaryCenter () const
	Optional method to compute centroid (default uses bounding box) More...

virtual fpreal	computeVolume (const UT_Vector3 &refpt) const
	Optional method to calculate volume (default uses bounding box) More...

virtual fpreal	computeArea () const
	Optional method to calculate surface area (default uses bounding box) More...

virtual fpreal	computePerimeter () const
	Optional method to calculate perimeter (default uses bounding box) More...

Protected Member Functions inherited from UT_IntrusiveRefCounter< GU_PackedImpl >
SYS_FORCE_INLINE	~UT_IntrusiveRefCounter ()
	Destructor: Only derived classes can destruct this. More...

Static Protected Member Functions
static void	copyPrimitiveGroups (GU_Detail &dest, const GU_Detail &src, GA_Offset src_offset, bool force=false)


template<typename T >
static bool	import (const UT_JSONValueMap &options, const UT_StringRef &key, T &value)

template<typename T >
static bool	import (const UT_Options &options, const UT_StringRef &key, T &value)

Static Protected Attributes
static const GEO_PackedNameMapPtr	theNullPackedNameMapPtr

Friends
class	GU_PrimPacked

Detailed Description

This class is used by the deferred load primitives to provide methods to handle the deferred geometry.

Load/save of shared primitive data If multiple instances of the packed primitive share data, it's possible to save this data just once (instead of per primitive).

There are two parts to saving shared data. Saving the actual data, but also saving a "key" used to resolve the shared data. The shared data itself is saved using saveSharedData(). In addition, the "key" associated with the shared data is saved per-primitive instance. During loading, the "key" is used to resolve the shared data.

When generating a key, the key must be unique within all shared data blocks for a single geometry. A simple way to do this would be to use the address of the shared data item. More complicated ways might include using a GUID, etc. For example, with a UT_SharedPtr<GU_Detail>, you might have generate a key using:

@code
UT_StringHolder     makeKey(const UT_SharedPtr<GU_Detail> &detail) {
    UT_WorkBuffer   key;
    key.sprintf("sharedgeo:%p", detail.get());
    return UT_StringHolder(key);
}

The saveSharedData() method writes a single JSON object to the save stream. During loading, the loader expects to load an array containing four items.

[
    "string Primitive_Name",
    "string Shared_Data_Type",
    "string Shared_Data_Identifier",
    shared_data
]

The Primitive_Name ensures that shared data resolution is tied to the specific primitive type. Kind of like a namespace.

The Shared_Data_Type is an identifier to allow primitives to store multiple types of shared data. For example, if you have a material definition and a geometry definition, these can be stored as separate shared blocks rather than creating separate shared blocks for each pair.

The Shared_Data_Identifier is a unique identifier used to specify a particular instance of a shared data block. This is the "key" that can be used to resolve the data at load time. See the makeKey() example above.

Example code might be something like

UT_StringHolder     key = makeKey(mySharedObject);
if (save_map.hasSavedSharedData(key))
    return true;    // Another primitive has saved the shared data
map.setSavedSharedData(key);
json.jsonStringToken(getFactory()->name());
// Used for seeking (see section on loading)
geo_index->addEntry(key, json.getNumBytesWritten());
json.beginArray();
json.jsonString("Shared_Data_Type");
json.jsonString(key);
json.jsonBeginMap();
    ...
json.jsonEndMap();
// Provide a seek point used for loading
UT_WorkBuffer       endkey(key);
endkey.append(GA_SAVEMAP_END_TOKEN);
geo_index->addEntry(endkey.buffer(), w.getNumBytesWritten());
ok = ok && w.jsonEndArray();

The save() method needs to store the key so the shared data can be resolved at load time. The identifier you use in the save method doesn't have to be the "Shared_Data_Type" string, but it does have to match the value in the load method. For example:

PrimClass::save(UT_Options &options, const GA_SaveMap &map) const {
     options.setOptionS("shareddata", makeKey());
}

Shared data loading may be deferred until the shared data is actually required. This is done using a "handle" to the shared data (GA_SharedDataHandlePtr). During the load() method, you can ask for a handle to any shared data.

bool load(const UT_Options &options, const GA_LoadMap &loadmap) {
   UT_StringHolder key;
   if (import(options, "shareddata", key)) {
       mySharedHandle = loadmap.needSharedData(key,
                                   getFactory()->name(), nullptr);
}

When loading primitives, the shared data is not actually available until later in the loading process. The primitive itself needs to hold a reference to the shared data handle so the shared data can be resolved at a later time.

Resolving the handle is done by asking the handle to resolve the shared data, and then extracting information from a sub-class of a GA_SharedLoadData object. If the shared data is never resolved, it's possible the GA_SharedLoadData may never read the data from the file (if the geometry format supports seeking, the loader may be able to use the offsets stored in the geo_index during writing). The code to resolve the data might look like:

if (mySharedHandle)
{
 const GA_SharedLoadData             *item;
 const CustomSharedLoadData  *data;
    item = mySharedHandle->resolveSharedData(packed_context);
    data = dynamic_cast<const CustomSharedLoadData *>(item);
    if (!data)
        return false;       // This really shouldn't ever happen
    copySharedData(data);
    /// Clear the reference to the @c GA_SharedDataHandlePtr.  When all
    /// references to the shared handle are cleared, the handle will be
    /// deleted.
    mySharedHandle.clear();
}

The last piece to loading, is the actual loading of the shared data block. Since shared data blocks must be able to be loaded without a primitive object, the loading is handled by the GU_PackedFactory subclass (the loadSharedData()) method. This method should create the sub-class of the GA_SharedLoadData object that's used when resolving shared data. For example

class CustomFactory : public GU_PackedFactory
{
    // The type matches the "Shared_Data_Type" described above
    // The key matches the "Shared_Data_Identifier" described above
    virtual GA_SharedLoadData   *loadSharedData(UT_JSONParser &p,
                                    const char *type,
                                    const char *key,
                                    bool is_delayed_load) const
    {
        CustomSharedLoadData    *data = new CustomSharedLoadData();
        // This just load the data.  For example the JSON Map saved in
        // the example above (not the entire array of shared data).
        if (!data->load(p))
        {
            delete data;
            return nullptr;     // Unable to load the shared data
        }
        return data;
    }
};

Examples:: packedshareddata/GU_PackedSharedData.C, packedshareddata/GU_PackedSharedData.h, packedsphere/GU_PackedSphere.C, and packedsphere/GU_PackedSphere.h.

Definition at line 185 of file GU_PackedImpl.h.