OP/OP_Utils.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.
 *
 * Produced by:
 *      Side Effects Software Inc.
 *      20 Maud St.
 *      Toronto, Ontario,  M5V 2M5
 *      Canada
 *      416-366-4607
 *
 * NAME:        OP Library (C++)
 *
 * COMMENTS:    Some utility functions for operators.
 *
 */

#ifndef __OP_Utils_h__
#define __OP_Utils_h__

#include "OP_API.h"
#include "OP_Node.h"

class OP_NetworkBoxItem;
class UT_WorkBuffer;
class UT_StringArray;

OP_API void      OPwarnBadRefs(UT_WorkBuffer &msg,
                               const UT_StringArray &badrefs);
OP_API bool      OPconvertOrWarnExternalReferences(OP_Node *node,
                                                   bool checktoplevelnode,
                                                   UT_WorkBuffer &err);
OP_API bool      OPconvertOrWarnExternalOverrides(OP_Node *node,
                                                  bool checktoplevelnode,
                                                  UT_WorkBuffer &err);
/// Looks for any nodes inside the specified operator that are defined by
/// VOP Networks outside the provided node. REtrns true if no such nodes
/// are found. Otherwise it puts an error message in the err buffer and
/// returns false.
OP_API bool      OPcheckForVopnetDefinedNodes(OP_Node *node,
                                              UT_WorkBuffer &err);
OP_API void      OPgetVopSubnetMask(OP_Node *node,
                                    UT_String &vopnetmask);

OP_API OP_Node *OPfindOpInput(OP_Node *op, const char *find_op_type,
                              bool include_me = true);
OP_API OP_Node *OPfindOpInput(OP_Node *op, const char **find_op_types,
                              bool include_me = true);

/// Returns coordinates specifying the smallest possible bounding box 
/// around the items in 'items'. Takes each item's height and width into 
/// consideration.
OP_API void     OPgetItemBounds(fpreal &x1, fpreal &y1, fpreal &x2, fpreal &y2, 
                                const UT_PtrArray<OP_NetworkBoxItem *> &items);

/// Looks for any VOP Networks inside the specified node which define operator
/// types that are instantiated outside the node. If it returns false, the
/// badvopnets array will be filled with the VOP Networks that are used
/// outside the root node.
OP_API bool      OPcheckForVopnetsUsedOutside(OP_Node *node,
                                              OP_NodeList *badvopnets);

#endif

---