tge/lib/mayasdk7/include/maya/MItDependencyNodes.h
2017-04-17 06:17:10 -06:00

138 lines
4.1 KiB
C++
Executable File

#ifndef _MItDependencyNodes
#define _MItDependencyNodes
//
//-
// ==========================================================================
// Copyright (C) 1995 - 2005 Alias Systems Corp. and/or its licensors. All
// rights reserved.
//
// The coded instructions, statements, computer programs, and/or related
// material (collectively the "Data") in these files contain unpublished
// information proprietary to Alias Systems Corp. ("Alias") and/or its
// licensors, which is protected by Canadian and US federal copyright law and
// by international treaties.
//
// The Data may not be disclosed or distributed to third parties or be copied
// or duplicated, in whole or in part, without the prior written consent of
// Alias.
//
// THE DATA IS PROVIDED "AS IS". ALIAS HEREBY DISCLAIMS ALL WARRANTIES RELATING
// TO THE DATA, INCLUDING, WITHOUT LIMITATION, ANY AND ALL EXPRESS OR IMPLIED
// WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND/OR FITNESS FOR A
// PARTICULAR PURPOSE. IN NO EVENT SHALL ALIAS BE LIABLE FOR ANY DAMAGES
// WHATSOEVER, WHETHER DIRECT, INDIRECT, SPECIAL, OR PUNITIVE, WHETHER IN AN
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, OR IN EQUITY,
// ARISING OUT OF ACCESS TO, USE OF, OR RELIANCE UPON THE DATA.
// ==========================================================================
//+
//
// CLASS: MItDependencyNodes
//
// *****************************************************************************
//
// CLASS DESCRIPTION (MItDependencyNodes)
//
// Use the dependency node iterator to traverse all the nodes in Maya's
// Dependency Graph.
//
// With filtering enabled, the iterator checks to see if the node is
// compatible with the type specified by the filter. See MFn::Type for a
// list of all valid types.
//
// Since MObjects may be compatible with more than one type (nodes are
// organised in a hierarchy) the MObject::hasFn() method can be used to
// further check for compatible types.
//
// Any compatible Function Set can be attached to the retrieved object to
// query or or edit it. Often you will want to use the dependency node
// function set (MFnDependencyNode), which is compatible with all
// dependency nodes, to perform queries on each node as the iterator
// Traverses the Dependency Graph.
//
// *****************************************************************************
#if defined __cplusplus
// *****************************************************************************
// INCLUDED HEADER FILES
#include <maya/MObject.h>
#include <maya/MStatus.h>
#include <maya/MIntArray.h>
// *****************************************************************************
// DECLARATIONS
class MDagPath;
class MDagPathArray;
class MString;
class MIteratorType;
// *****************************************************************************
// CLASS DECLARATION (MItDependencyNodes)
/// Dependency Node iterator
/**
Iterate over all nodes in the dependency graph.
*/
#ifdef _WIN32
#pragma warning(disable: 4522)
#endif // _WIN32
class OPENMAYA_EXPORT MItDependencyNodes
{
public:
///
MItDependencyNodes( MFn::Type filter = MFn::kInvalid,
MStatus * ReturnStatus = NULL );
///
MItDependencyNodes( MIteratorType& infoObject,
MStatus * ReturnStatus = NULL );
///
virtual ~MItDependencyNodes();
///
MStatus reset( MFn::Type filter = MFn::kInvalid );
///
MStatus reset(MIteratorType& infoObject);
///
MObject thisNode( MStatus * ReturnStatus = NULL ) const;
///
MStatus next();
///
bool isDone( MStatus * ReturnStatus = NULL ) const;
/// OBSOLETE
MObject item( MStatus * ReturnStatus = NULL ) const;
protected:
// No protected members
private:
static const char* className();
bool objectHasFnOnFilterOrList(const MObject& mobject);
void* f_data;
MFn::Type f_filter;
MIntArray filterList;
bool useFilterList;
};
#ifdef _WIN32
#pragma warning(default: 4522)
#endif // _WIN32
// *****************************************************************************
#endif /* __cplusplus */
#endif /* _MItDependencyNodes */