SIM_FullPathData.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
*/

#ifndef __SIM_FullPathData_h__
#define __SIM_FullPathData_h__

#include "SIM_API.h"
#include <GU/GU_DetailHandle.h>
#include <UT/UT_StringHolder.h>

class SIM_Data;
class SIM_Engine;
class SIM_Position;
class SIM_RootData;
class SIM_Time;

struct SIM_API SIM_FullPathData
{
    const SIM_RootData *myRootData = nullptr;
    const SIM_Data *myData = nullptr;
    UT_StringHolder myDataName;
};

/// Version of DOPfindDataFromPath() that uses the provided SIM_Engine instead
/// of searching for a DOP node at the beginning of the path.
SIM_API bool SIMfindDataFromPath(
        const char *path,
        SIM_FullPathData &fulldata,
        const SIM_Engine &engine,
        const SIM_Time &sim_time,
        bool interpolate_data);

/// Version of DOPfindAllDataFromPath() that uses the provided SIM_Engine
/// instead of searching for a DOP node at the beginning of the path.
SIM_API bool SIMfindAllDataFromPath(
        const char *path,
        UT_Array<SIM_FullPathData> &fulldata,
        const SIM_Engine &engine,
        const SIM_Time &sim_time,
        bool interpolate_data);

/// Return the geometry and transform for the provided data path.
/// This handles data types other than SIM_Geometry - e.g. SIM_Object (returning
/// the object's geometry), SIM_SDF and other field types, and unknown types are
/// converted to their guide geometry if possible.
SIM_API GU_ConstDetailHandle SIMgetBestGeometry(
        UT_DMatrix4 &xform,
        const SIM_RootData *rootdata,
        const SIM_Data *data,
        const char *dataname,
        const SIM_Time &simtime,
        const bool doceflush = true);

SIM_API const SIM_Position *SIMgetBestPosition(
        const SIM_RootData *rootdata,
        const SIM_Data *data,
        const char *dataname);

#endif