All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OP_IndirectInput Class Referenceabstract

#include <OP_IndirectInput.h>

+ Inheritance diagram for OP_IndirectInput:

Public Member Functions

 OP_IndirectInput (OP_Network &owner)
 ~OP_IndirectInput () override
virtual OP_NetworkBoxItemgetInputItem () const =0
virtual int getInputItemOutputIndex () const =0
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 ()
virtual fpreal getW () const =0
virtual fpreal getH () const =0
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 OP_ItemType getItemType () const =0
 Our children should implement this and return what type of item they are. More...
virtual const UT_StringgetItemName () const =0
virtual bool setItemName (const UT_String &name)=0
virtual int64 getItemUniqueId () const =0
 Functions to get hip-file-unique ids for any item type. 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 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)

Protected Member Functions

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


class OP_Input
class OP_Network

Additional Inherited Members

- Protected Attributes inherited from OP_NetworkBoxItem
UT_Color myColor

Detailed Description

Definition at line 31 of file OP_IndirectInput.h.

Constructor & Destructor Documentation

OP_IndirectInput::OP_IndirectInput ( OP_Network owner)
OP_IndirectInput::~OP_IndirectInput ( )

Member Function Documentation

void OP_IndirectInput::clearOutputs ( bool  for_delete = false)
static UT_Color OP_IndirectInput::getDefaultColor ( )
OP_Node* OP_IndirectInput::getFirstOutputNode ( ) const
virtual OP_NetworkBoxItem* OP_IndirectInput::getInputItem ( ) const
pure virtual

Implemented in OP_Dot, and OP_SubnetIndirectInput.

virtual int OP_IndirectInput::getInputItemOutputIndex ( ) const
pure virtual

Implemented in OP_Dot, and OP_SubnetIndirectInput.

int64 OP_IndirectInput::getMemoryUsage ( bool  inclusive) const

Definition at line 98 of file OP_IndirectInput.h.

OP_Node* OP_IndirectInput::getNode ( )
const OP_Node* OP_IndirectInput::getNode ( ) const
int OP_IndirectInput::getNodeOutputIndex ( )
unsigned OP_IndirectInput::getNOutputs ( ) const

Definition at line 50 of file OP_IndirectInput.h.

OP_NetworkBoxItem* OP_IndirectInput::getOutput ( unsigned  idx) const

Definition at line 52 of file OP_IndirectInput.h.

void OP_IndirectInput::getOutputNodes ( UT_Array< OP_Node * > &  nodes,
bool  into_subnets = false 
) const
OP_Network* OP_IndirectInput::getOwner ( ) const
OP_Network* OP_IndirectInput::getParentNetwork ( ) const

Returns the network that is our parent.

Implements OP_NetworkBoxItem.

bool OP_IndirectInput::getPicked ( ) const

Implements OP_NetworkBoxItem.

const UT_StringHolder& OP_IndirectInput::getSymbolicColorName ( ) const
bool OP_IndirectInput::getUseColorFromOutput ( ) const
fpreal OP_IndirectInput::getX ( ) const

Implements OP_NetworkBoxItem.

Definition at line 81 of file OP_IndirectInput.h.

fpreal OP_IndirectInput::getY ( ) const

Implements OP_NetworkBoxItem.

Definition at line 83 of file OP_IndirectInput.h.

void OP_IndirectInput::initFromFile ( const UT_StringHolder clrstr,
const UT_StringHolder netboxname,
fpreal  x,
fpreal  y 
void OP_IndirectInput::initFromIndirect ( const OP_IndirectInput src)
void OP_IndirectInput::propagateModification ( OP_Node by_whom,
OP_EventType  reason,
int  parm_index,
OP_PropagateData prop_data 
void OP_IndirectInput::saveColorString ( std::ostream &  os) const
bool OP_IndirectInput::setColor ( const UT_Color color)

Reimplemented from OP_NetworkBoxItem.

bool OP_IndirectInput::setPicked ( bool  on_off,
bool  propagate_parent_event = true 

Implements OP_NetworkBoxItem.

bool OP_IndirectInput::setSymbolicColorName ( const UT_StringHolder name)
bool OP_IndirectInput::setUseColorFromOutput ( bool  use_output_color)
void OP_IndirectInput::setXY ( fpreal  x,
fpreal  y 

Get and set the position of this item. Units are absolute, as opposed to relative units found in OPUI.

Implements OP_NetworkBoxItem.

bool OP_IndirectInput::traverseOutputNodes ( hboost::function< bool(const OP_Node &)>  cb) const

Friends And Related Function Documentation

friend class OP_Input

Definition at line 134 of file OP_IndirectInput.h.

friend class OP_Network

Definition at line 135 of file OP_IndirectInput.h.

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