OP_DotList Class Reference

#include <OP_DotList.h>

Public Types
using	iterator = DotArray::iterator
using	const_iterator = DotArray::const_iterator

Public Member Functions
	OP_DotList (OP_Network &net)
	~OP_DotList ()
exint	entries () const
OP_Dot *	operator() (exint idx) const
exint	find (OP_Dot *dot) const
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
OP_Dot *	findDot (const char *name) const
OP_Dot *	createDot (bool save_undo=true)
bool	deleteDot (OP_Dot &dot_to_delete, bool save_undo=true)
void	clearAndDestroy ()
OP_ERROR	save (std::ostream &os, OP_Dot &dot, const OP_SaveFlags &flags, const char *path_prefix) const
	Save a single dot into a CPIO packet. More...
bool	load (UT_IStream &is, const char *path, bool path_contains_network, bool path_contains_packet_ext, OP_OverwriteAction overwrite=OP_NO_OVERWRITE, OP_Dot **created=NULL)
int64	getMemoryUsage (bool inclusive) const
	Return the amount of memory owned by this OP_DotList. More...

Detailed Description

Definition at line 26 of file OP_DotList.h.

Member Typedef Documentation

using OP_DotList::const_iterator = DotArray::const_iterator

Definition at line 44 of file OP_DotList.h.

using OP_DotList::iterator = DotArray::iterator

Definition at line 43 of file OP_DotList.h.

Constructor & Destructor Documentation

OP_DotList::OP_DotList

(

OP_Network &

net

)

OP_DotList::~OP_DotList

(

)

Member Function Documentation

iterator OP_DotList::begin ( void  )

inline

Definition at line 46 of file OP_DotList.h.

const_iterator OP_DotList::begin ( void  ) const

inline

Definition at line 48 of file OP_DotList.h.

void OP_DotList::clearAndDestroy

(

)

OP_Dot* OP_DotList::createDot

(

bool

save_undo = true

)

bool OP_DotList::deleteDot	(	OP_Dot &	dot_to_delete,
		bool	save_undo = true
	)

iterator OP_DotList::end ( void  )

inline

Definition at line 47 of file OP_DotList.h.

const_iterator OP_DotList::end ( void  ) const

inline

Definition at line 49 of file OP_DotList.h.

exint OP_DotList::entries ( ) const

inline

Definition at line 34 of file OP_DotList.h.

exint OP_DotList::find ( OP_Dot *  dot ) const

inline

Definition at line 40 of file OP_DotList.h.

OP_Dot* OP_DotList::findDot

(

const char *

name

)

const

int64 OP_DotList::getMemoryUsage

(

bool

inclusive

)

const

Return the amount of memory owned by this OP_DotList.

bool OP_DotList::load	(	UT_IStream &	is,
		const char *	path,
		bool	path_contains_network,
		bool	path_contains_packet_ext,
		OP_OverwriteAction	overwrite = OP_NO_OVERWRITE,
		OP_Dot **	created = NULL
	)

Load a network box from 'is'. Can load from both .hip files and the clipboard. 'path' is used as the new netbox's name (only the portion of path after the last slash). If 'overwrite' is specified, the new netbox will overwrite any other netboxes in this network with the same name, rather than modify its name to be unique. 'created' is used to return a ptr to the new network box.

OP_Dot* OP_DotList::operator() ( exint  idx ) const

inline

Definition at line 36 of file OP_DotList.h.

OP_ERROR OP_DotList::save	(	std::ostream &	os,
		OP_Dot &	dot,
		const OP_SaveFlags &	flags,
		const char *	path_prefix
	)		const

Save a single dot into a CPIO packet.

---

The documentation for this class was generated from the following file:

• OP/OP_DotList.h