HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
HOM_ApexNode Class Referenceabstract

#include <HOM_ApexNode.h>

+ Inheritance diagram for HOM_ApexNode:

Public Member Functions

 HOM_ApexNode ()
 
 HOM_ApexNode (const HOM_ApexNode &node)
 
 ~HOM_ApexNode () override
 
std::string __repr__ () override=0
 
std::string __str__ () override=0
 
virtual std::string inputName (int input_index)=0
 
virtual void setInputName (int input_index, const char *name)=0
 
virtual std::string outputName (int output_index)=0
 
virtual void setOutputName (int output_index, const char *name)=0
 
virtual std::vector< std::string > inputDataTypes ()=0
 
virtual std::vector< std::string > outputDataTypes ()=0
 
virtual std::vector< std::string > tags ()=0
 
virtual void setTags (const std::vector< std::string > &tags)=0
 
virtual bool isSubgraphAsset ()=0
 
- Public Member Functions inherited from HOM_Node
 HOM_Node ()
 
 HOM_Node (const HOM_Node &node)
 
 ~HOM_Node () override
 
virtual bool operator== (HOM_PtrOrNull< HOM_Node > node)=0
 
virtual bool operator!= (HOM_PtrOrNull< HOM_Node > node)=0
 
int __hash__ () override=0
 
virtual bool isNetwork ()=0
 
virtual bool isEditable ()=0
 
virtual HOM_NodeType * type ()=0
 
virtual HOM_NodeTypeCategory * childTypeCategory ()=0
 
virtual bool isFlagReadable (HOM_EnumValue &flag)=0
 
virtual bool isFlagWritable (HOM_EnumValue &flag)=0
 
virtual bool isGenericFlagSet (HOM_EnumValue &flag)=0
 
virtual void setGenericFlag (HOM_EnumValue &flag, bool value)=0
 
virtual bool isDisplayDescriptiveNameFlagSet ()=0
 
virtual void setDisplayDescriptiveNameFlag (bool on)=0
 
virtual std::vector< std::string > errors ()=0
 
virtual std::vector< std::string > warnings ()=0
 
virtual std::vector< std::string > messages ()=0
 
virtual HOM_Node * node (const char *node_path)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		nodes (const std::vector< std::string > &node_paths)=0
 
virtual HOM_NetworkMovableItem * item (const char *item_path)=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_NetworkMovableItem > > 		items (const std::vector< std::string > &item_paths)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		glob (const char *pattern, bool ignore_case=false)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		recursiveGlob (const char *pattern, HOM_EnumValue &filter=HOM_nodeTypeFilter::NoFilter, bool include_subnets=true)=0
 
virtual HOM_Node * createNode (const char *node_type_name, const char *node_name=NULL, bool run_init_scripts=true, bool load_contents=true, bool exact_type_name=false, bool force_valid_node_name=false)=0
 
virtual int inputIndex (const char *input_name)=0
 
virtual int outputIndex (const char *output_name)=0
 
virtual void setInput (int input_index, HOM_NetworkMovableItem *item_to_become_input, int output_index=0)=0
 
virtual void setNamedInput (const char *input_name, HOM_NetworkMovableItem *item_to_become_input, const char *output_name)=0
 
virtual void setNamedInput (const char *input_name, HOM_NetworkMovableItem *item_to_become_input, int output_index)=0
 
virtual void setFirstInput (HOM_NetworkMovableItem *item_to_become_input, int output_index=0)=0
 
virtual void setNextInput (HOM_NetworkMovableItem *item_to_become_input, int output_index=0, bool unordered_only=false)=0
 
virtual void insertInput (int input_index, HOM_NetworkMovableItem *item_to_become_input, int output_index=0)=0
 
virtual int numOrderedInputs ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		inputs ()=0
 
virtual HOM_Node * input (int input_index)=0
 
virtual HOM_Node * inputFollowingOutputs (int input_index)=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_NodeConnection > > 		inputConnections ()=0
 
virtual HOM_IterableList
< std::vector< HOM_ElemPtr
< HOM_NodeConnection > > > * 		inputConnectors ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		inputAncestors (bool include_ref_inputs=true, bool follow_subnets=false, bool only_used_inputs=false)=0
 
virtual std::vector< std::string > inputNames ()=0
 
virtual std::vector< std::string > inputLabels ()=0
 
virtual std::map< std::string,
std::string > 		editableInputStrings (int input_index)=0
 
virtual std::string editableInputString (int input_index, const char *key)=0
 
virtual void setEditableInputString (int input_index, const char *key, const char *value)=0
 
virtual std::vector< std::string > outputNames ()=0
 
virtual std::vector< std::string > outputLabels ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		outputs ()=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_NodeConnection > > 		outputConnections ()=0
 
virtual HOM_IterableList
< std::vector< HOM_ElemPtr
< HOM_NodeConnection > > > * 		outputConnectors ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		children ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		allSubChildren (bool top_down=true, bool recurse_in_locked_nodes=true, bool sync_delayed_definition=false)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		selectedChildren (bool include_hidden=false, bool include_hidden_support_nodes=false)=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_NetworkMovableItem > > 		allItems ()=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_NetworkMovableItem > > 		allSubItems (bool top_down=true, bool recurse_in_locked_nodes=true, bool sync_delayed_definition=false)=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_NetworkMovableItem > > 		selectedItems (bool include_hidden=false, bool include_hidden_support_nodes=false)=0
 
virtual int numItems (HOM_EnumValue *item_type=NULL, bool selected_only=false, bool include_hidden=false)=0
 
virtual void deleteItems (const std::vector< HOM_NetworkMovableItem * > &items=std::vector< HOM_NetworkMovableItem * >(), bool disable_safety_checks=false)=0
 
virtual void copyItemsToClipboard (const std::vector< HOM_NetworkMovableItem * > &items=std::vector< HOM_NetworkMovableItem * >())=0
 
virtual void pasteItemsFromClipboard (HOM_Vector2 *position=NULL)=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_NetworkMovableItem > > 		copyItems (const std::vector< HOM_NetworkMovableItem * > &items, bool channel_reference_originals=false, bool relative_references=true, bool connect_outputs_to_multi_inputs=false)=0
 
virtual HOM_Node * creator ()=0
 
virtual HOM_Vector2 * moveToGoodPosition (bool relative_to_inputs=true, bool move_inputs=true, bool move_outputs=true, bool move_unconnected=true)=0
 
 SWIGOUT (%kwargs layoutChildren)
 
virtual void layoutChildren (const std::vector< HOM_NetworkMovableItem * > &items=std::vector< HOM_NetworkMovableItem * >(), double horizontal_spacing=-1, double vertical_spacing=-1)=0
 
virtual bool isCurrent ()=0
 
virtual void setCurrent (bool on, bool clear_all_selected=false)=0
 
virtual bool isHidden ()=0
 
virtual void hide (bool on)=0
 
virtual std::string comment ()=0
 
virtual void setComment (const char *comment)=0
 
virtual void appendComment (const char *comment)=0
 
virtual void destroy (bool disable_safety_checks=false)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_NetworkBox > > 		networkBoxes ()=0
 
virtual HOM_IterableList
< HOM_NetworkBox > * 		iterNetworkBoxes ()=0
 
virtual HOM_NetworkBox * createNetworkBox (const char *name=NULL)=0
 
virtual HOM_NetworkBox * copyNetworkBox (HOM_NetworkBox &network_box_to_copy, const char *new_name=NULL, bool channel_reference_original=false)=0
 
virtual HOM_NetworkBox * findNetworkBox (const char *name)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_NetworkBox > > 		findNetworkBoxes (const char *pattern)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_NetworkDot > > 		networkDots ()=0
 
virtual HOM_NetworkDot * createNetworkDot ()=0
 
virtual bool canCreateDigitalAsset ()=0
 
virtual HOM_Node * collapseIntoSubnet (const std::vector< HOM_NetworkMovableItem * > &child_items, const char *subnet_name=NULL, const char *subnet_type=NULL)=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_NetworkMovableItem > > 		extractAndDelete ()=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_SubnetIndirectInput > > 		indirectInputs ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		subnetOutputs ()=0
 
virtual bool isSubNetwork ()=0
 
virtual void setUserData (const char *name, const std::string &value)=0
 
virtual hboost::any boostAnyUserData (const char *name)=0
 
virtual void destroyUserData (const char *name, bool must_exist=true)=0
 
virtual void clearUserDataDict ()=0
 
virtual std::map< std::string,
std::string > 		userDataDict ()=0
 
virtual HOM_StickyNote * createStickyNote (const char *name=NULL)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_StickyNote > > 		stickyNotes ()=0
 
virtual HOM_IterableList
< HOM_StickyNote > * 		iterStickyNotes ()=0
 
virtual HOM_StickyNote * copyStickyNote (HOM_StickyNote &sticky_note_to_copy, const char *new_name=NULL)=0
 
virtual HOM_StickyNote * findStickyNote (const char *name)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_StickyNote > > 		findStickyNotes (const char *pattern)=0
 
- Public Member Functions inherited from HOM_NetworkMovableItem
 HOM_NetworkMovableItem (HOM_EnumValue &network_item_type)
 
 HOM_NetworkMovableItem (const HOM_NetworkMovableItem &src)
 
 ~HOM_NetworkMovableItem () override
 
virtual std::string name ()=0
 
virtual void setName (const char *name, bool unique_name=false)=0
 
virtual int digitsInName ()=0
 
virtual std::string path ()=0
 
virtual std::string relativePathTo (HOM_NetworkMovableItem &base_item)=0
 
virtual bool isSelected ()=0
 
virtual void setSelected (bool on, bool clear_all_selected=false, bool show_asset_if_selected=false)=0
 
virtual HOM_Color color ()=0
 
virtual void setColor (HOM_Color &color)=0
 
virtual HOM_Vector2 size ()=0
 
virtual HOM_Vector2 position ()=0
 
virtual void setPosition (const std::vector< double > &position)=0
 
virtual void move (const std::vector< double > &amount)=0
 
virtual HOM_Node * parent ()=0
 
virtual HOM_NetworkBox * parentNetworkBox ()=0
 
virtual int64 sessionId ()=0
 
- Public Member Functions inherited from HOM_NetworkItem
 HOM_NetworkItem (HOM_EnumValue &network_item_type)
 
 HOM_NetworkItem (const HOM_NetworkItem &src)
 
virtual ~HOM_NetworkItem ()
 
HOM_EnumValue & networkItemType ()
 

Detailed Description

Definition at line 17 of file HOM_ApexNode.h.

Constructor & Destructor Documentation

HOM_ApexNode::HOM_ApexNode ( )
inline

Definition at line 20 of file HOM_ApexNode.h.

HOM_ApexNode::HOM_ApexNode ( const HOM_ApexNode &  node)
inline

Definition at line 23 of file HOM_ApexNode.h.

HOM_ApexNode::~HOM_ApexNode ( )
inlineoverride

Definition at line 27 of file HOM_ApexNode.h.

Member Function Documentation

std::string HOM_ApexNode::__repr__ ( )
overridepure virtual

Implements HOM_Node.

std::string HOM_ApexNode::__str__ ( )
overridepure virtual

Implements HOM_Node.

virtual std::vector<std::string> HOM_ApexNode::inputDataTypes ( )
pure virtual
virtual std::string HOM_ApexNode::inputName ( int  input_index)
pure virtual
virtual bool HOM_ApexNode::isSubgraphAsset ( )
pure virtual
virtual std::vector<std::string> HOM_ApexNode::outputDataTypes ( )
pure virtual
virtual std::string HOM_ApexNode::outputName ( int  output_index)
pure virtual
virtual void HOM_ApexNode::setInputName ( int  input_index,
const char *  name 
)
pure virtual
virtual void HOM_ApexNode::setOutputName ( int  output_index,
const char *  name 
)
pure virtual
virtual void HOM_ApexNode::setTags ( const std::vector< std::string > &  tags)
pure virtual
virtual std::vector<std::string> HOM_ApexNode::tags ( )
pure virtual
The documentation for this class was generated from the following file: