HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OP_Dot Class Reference

#include <OP_Dot.h>

+ Inheritance diagram for OP_Dot:

Public Member Functions

OP_ItemType getItemType () const override
 Our children should implement this and return what type of item they are. More...
 
fpreal getW () const override
 
fpreal getH () const override
 
const UT_StringgetItemName () const override
 
bool setItemName (const UT_String &name) override
 
void setInput (OP_NetworkBoxItem *item, int outputidx, bool for_delete_old_input=false)
 
OP_InputgetInputReference ()
 
const OP_InputgetInputReferenceConst () const
 
OP_NetworkBoxItemgetInputItem () const override
 
int getInputItemOutputIndex () const override
 
bool isPinned () const
 
bool setPinned (bool pinned)
 
int getUniqueId () const
 
int64 getItemUniqueId () const override
 Functions to get hip-file-unique ids for any item type. More...
 
int64 getMemoryUsage (bool inclusive) const
 
- Public Member Functions inherited from OP_IndirectInput
 OP_IndirectInput (OP_Network &owner)
 
 ~OP_IndirectInput () override
 
OP_NodegetNode ()
 
const OP_NodegetNode () const
 
int getNodeOutputIndex ()
 
unsigned getNOutputs () const
 
OP_NetworkBoxItemgetOutput (unsigned idx) const
 
void clearOutputs (bool for_delete=false)
 
void getOutputNodes (UT_Array< OP_Node * > &nodes, bool into_subnets=false) const
 
bool traverseOutputNodes (hboost::function< bool(const OP_Node &)> cb) const
 
OP_NodegetFirstOutputNode () const
 
OP_NetworkgetParentNetwork () const override
 Returns the network that is our parent. More...
 
OP_NetworkgetOwner () const
 
bool setPicked (bool on_off, bool propagate_parent_event=true) override
 
bool getPicked () const override
 
void setXY (fpreal x, fpreal y) override
 
fpreal getX () const override
 
fpreal getY () const override
 
bool setColor (const UT_Color &color) override
 
bool setUseColorFromOutput (bool use_output_color)
 
bool getUseColorFromOutput () const
 
bool setSymbolicColorName (const UT_StringHolder &name)
 
const UT_StringHoldergetSymbolicColorName () const
 
int64 getMemoryUsage (bool inclusive) const
 
- Public Member Functions inherited from OP_NetworkBoxItem
 OP_NetworkBoxItem ()
 
virtual ~OP_NetworkBoxItem ()
 
bool setXYWithBoundsChecks (fpreal x, fpreal y)
 
void validateSafeBounds (fpreal &x, fpreal &y)
 
void validateSafeBounds (fpreal &x, fpreal &y, fpreal &w, fpreal &h)
 
void moveToGoodPosition (bool relativetoinputs=true, bool moveinputs=true, bool moveoutputs=true, bool moveunconnected=true)
 
void setOwnerBox (OP_NetworkBox *box)
 
OP_NetworkBoxgetOwnerBox () const
 
bool hasOwnerBox (const OP_NetworkBoxItem *item) const
 
OP_NetworkBoxgetMinimizedOwnerBox () const
 
void getPathFromParent (UT_String &str, const OP_Node *parent) const
 
void getPathFromParent (UT_WorkBuffer &str, const OP_Node *parent) const
 
void getRelativePathTo (const OP_NetworkBoxItem *base_item, UT_String &result) const
 Returns the path of this item relative to 'base_item'. More...
 
virtual UT_Color getColor () const
 Accessors for color used in the network view. More...
 
virtual bool getItemExpose () const
 
virtual void setItemExpose (bool expose)
 
OP_NetworkgetCreator () const
 
OP_NetworkgetCodeCreator () const
 
void getConnectedItems (OP_NetworkBoxItemList &connected, bool inputs, bool recursive, bool include_this_item) const
 Fills an array with all network box items connected to this item. More...
 
int64 getMemoryUsage (bool inclusive) const
 

Static Public Member Functions

static OP_DotlookupDot (int id)
 Functions to get hip-file-unique ids for any item type. More...
 
- Static Public Member Functions inherited from OP_IndirectInput
static UT_Color getDefaultColor ()
 
- Static Public Member Functions inherited from OP_NetworkBoxItem
static fpreal getMaxSafeX ()
 The following methods return the safe extents of the position of items. More...
 
static fpreal getMinSafeX ()
 
static fpreal getMaxSafeY ()
 
static fpreal getMinSafeY ()
 
static OP_NetworkBoxItemlookupItem (const OP_ItemType &type, int64 id)
 
static OP_NetworkBoxItemlookupItem (const OP_ItemId &id)
 

Friends

class OP_DotList
 

Additional Inherited Members

- Protected Member Functions inherited from OP_IndirectInput
void initFromIndirect (const OP_IndirectInput &src)
 
void initFromFile (const UT_StringHolder &clrstr, const UT_StringHolder &netboxname, fpreal x, fpreal y)
 
void saveColorString (std::ostream &os) const
 
void propagateModification (OP_Node *by_whom, OP_EventType reason, int parm_index, OP_PropagateData &prop_data)
 
- Protected Member Functions inherited from UT_NonCopyableNS::UT_NonCopyable
 UT_NonCopyable ()=default
 
 ~UT_NonCopyable ()=default
 
 UT_NonCopyable (const UT_NonCopyable &)=delete
 
UT_NonCopyableoperator= (const UT_NonCopyable &)=delete
 
- Protected Attributes inherited from OP_NetworkBoxItem
UT_Color myColor
 

Detailed Description

Definition at line 24 of file OP_Dot.h.

Member Function Documentation

fpreal OP_Dot::getH ( ) const
inlineoverridevirtual

Implements OP_NetworkBoxItem.

Definition at line 31 of file OP_Dot.h.

OP_NetworkBoxItem* OP_Dot::getInputItem ( ) const
overridevirtual

Implements OP_IndirectInput.

int OP_Dot::getInputItemOutputIndex ( ) const
overridevirtual

Implements OP_IndirectInput.

OP_Input* OP_Dot::getInputReference ( )
const OP_Input* OP_Dot::getInputReferenceConst ( ) const
const UT_String& OP_Dot::getItemName ( ) const
overridevirtual

Basically the same as OP_Node::getName(), but abstracted to a higher level so we can call it on all items.

Implements OP_NetworkBoxItem.

OP_ItemType OP_Dot::getItemType ( ) const
inlineoverridevirtual

Our children should implement this and return what type of item they are.

Implements OP_NetworkBoxItem.

Definition at line 27 of file OP_Dot.h.

int64 OP_Dot::getItemUniqueId ( ) const
inlineoverridevirtual

Functions to get hip-file-unique ids for any item type.

Implements OP_NetworkBoxItem.

Definition at line 55 of file OP_Dot.h.

int64 OP_Dot::getMemoryUsage ( bool  inclusive) const
inline

Returns the amount of memory owned by this OP_Dot (JUST this class; not subclasses)

Definition at line 60 of file OP_Dot.h.

int OP_Dot::getUniqueId ( ) const
fpreal OP_Dot::getW ( ) const
inlineoverridevirtual

Implements OP_NetworkBoxItem.

Definition at line 29 of file OP_Dot.h.

bool OP_Dot::isPinned ( ) const
static OP_Dot* OP_Dot::lookupDot ( int  id)
static

Functions to get hip-file-unique ids for any item type.

void OP_Dot::setInput ( OP_NetworkBoxItem item,
int  outputidx,
bool  for_delete_old_input = false 
)
bool OP_Dot::setItemName ( const UT_String name)
overridevirtual

Implements OP_NetworkBoxItem.

bool OP_Dot::setPinned ( bool  pinned)

Friends And Related Function Documentation

friend class OP_DotList
friend

Definition at line 83 of file OP_Dot.h.


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