VOP_SubnetOutput Class Reference

#include <VOP_SubnetOutput.h>

Inheritance diagram for VOP_SubnetOutput:

VOP_Node VOP_OutputNameEditorSource OP_Network OP_Node OP_Parameters OP_NetworkBoxItem PRM_ParmOwner

List of all members.

Public Member Functions

virtual void getCode (UT_String &codestr, VOP_CodeVarMapperContext *context=NULL)
virtual const char * inputLabel (unsigned idx) const
virtual unsigned getNumVisibleInputs () const
virtual bool forceCodeGenerationOfInputs (VOP_ContextType type, bool essential) const
virtual void moveInput (int srcidx, int dstidx, bool forcesubnet=false)
void moveInputInternal (int srcidx, int dstidx, bool forcesubnet)
virtual OP_ERROR setInput (unsigned idx, OP_Node *op, unsigned outputIdx=0)
virtual OP_ERROR setInputReference (unsigned idx, const char *label, int keeppos, unsigned outputIdx=0)
 Connects an input to particular node by name in the network.
virtual
VOP_OutputNameEditorSource
getOutputNameEditorSource ()
 Returns a pointer used by OPUI_OutputNameEditor to get and set data.
virtual int getNumInputsFromParent () const
virtual void NAMEFROMPARM (UT_String &str, int idx) const
virtual void LABELFROMPARM (UT_String &str, int idx) const
virtual void setNAMEFROMPARM (UT_String &str, int idx)
virtual void setLABELFROMPARM (UT_String &str, int idx)
void beginWiring ()
void endWiring ()

Static Public Member Functions

static OP_NodemyConstructor (OP_Network *net, const char *name, OP_Operator *entry)

Static Public Attributes

static PRM_Template myTemplateList []

Protected Member Functions

 VOP_SubnetOutput (OP_Network *parent, const char *name, OP_Operator *entry)
virtual ~VOP_SubnetOutput ()
virtual void preOpChanged (OP_EventType reason, void *data)
virtual void getInputNameSubclass (UT_String &in, int idx) const
virtual int getInputFromNameSubclass (const UT_String &in) const
virtual VOP_Type getInputTypeSubclass (int idx)
virtual void getAllowedInputTypesSubclass (unsigned idx, VOP_VopTypeArray &voptypes)


Detailed Description

Definition at line 24 of file VOP_SubnetOutput.h.


Constructor & Destructor Documentation

VOP_SubnetOutput::VOP_SubnetOutput ( OP_Network parent,
const char *  name,
OP_Operator entry 
) [protected]

virtual VOP_SubnetOutput::~VOP_SubnetOutput (  )  [protected, virtual]


Member Function Documentation

void VOP_SubnetOutput::beginWiring (  ) 

void VOP_SubnetOutput::endWiring (  ) 

virtual bool VOP_SubnetOutput::forceCodeGenerationOfInputs ( VOP_ContextType  context_type,
bool  essential 
) const [virtual]

Determines if the code generation should collect code-generating nodes by recursively traversing the input nodes starting from this node. This returns true for nodes such as: output node, output variable, code node, print node, etc, and returns false for nodes such as global variables, add node, etc. The essential flag is used to urge the nodes to report true if they really think they are essential. This was introduced with multi-context vopnets because previously a wide range of nodes would report true (eg, a null, as context-specific subnets) which would then make way into incompatible contexts. The essential flag is meant to weed out all such nodes and only let through output and export variables nodes.

Reimplemented from VOP_Node.

virtual void VOP_SubnetOutput::getAllowedInputTypesSubclass ( unsigned  idx,
VOP_VopTypeArray voptypes 
) [protected, virtual]

This methods should be overriden in most VOP nodes. It should fill in voptypes vector with vop types that are allowed to be connected to this node at the input at index idx. Note that unlike getInputTypeSubclass(), this method should return valid vop types even when nothing is connected to the corresponding input.

Reimplemented from VOP_Node.

virtual void VOP_SubnetOutput::getCode ( UT_String codestr,
VOP_CodeVarMapperContext context = NULL 
) [virtual]

Reimplemented from VOP_Node.

virtual int VOP_SubnetOutput::getInputFromNameSubclass ( const UT_String in  )  const [protected, virtual]

Reimplemented from VOP_Node.

virtual void VOP_SubnetOutput::getInputNameSubclass ( UT_String in,
int  idx 
) const [protected, virtual]

Returns the variable name associated with a given input number. Implementers of this function should also implement the reverse function.

Reimplemented from VOP_Node.

virtual VOP_Type VOP_SubnetOutput::getInputTypeSubclass ( int  idx  )  [protected, virtual]

Reimplemented from VOP_Node.

virtual int VOP_SubnetOutput::getNumInputsFromParent (  )  const [virtual]

virtual unsigned VOP_SubnetOutput::getNumVisibleInputs (  )  const [virtual]

Number of input connectors that should be visible on a node. This is only used by VOPs and DOPs. All other OPs return maxInputs() here.

Reimplemented from OP_Node.

virtual VOP_OutputNameEditorSource* VOP_SubnetOutput::getOutputNameEditorSource (  )  [inline, virtual]

Returns a pointer used by OPUI_OutputNameEditor to get and set data.

Reimplemented from VOP_Node.

Definition at line 63 of file VOP_SubnetOutput.h.

virtual const char* VOP_SubnetOutput::inputLabel ( unsigned  idx  )  const [virtual]

Reimplemented from OP_Node.

virtual void VOP_SubnetOutput::LABELFROMPARM ( UT_String str,
int  idx 
) const [virtual]

virtual void VOP_SubnetOutput::moveInput ( int  srcidx,
int  dstidx,
bool  forcesubnet = false 
) [virtual]

For subnet VOPs, when moving an input, we want to go in and reorganize the connections to our subinput and suboutput nodes so that the internal connections remain the same.

Reimplemented from VOP_Node.

void VOP_SubnetOutput::moveInputInternal ( int  srcidx,
int  dstidx,
bool  forcesubnet 
)

static OP_Node* VOP_SubnetOutput::myConstructor ( OP_Network net,
const char *  name,
OP_Operator entry 
) [static]

virtual void VOP_SubnetOutput::NAMEFROMPARM ( UT_String str,
int  idx 
) const [virtual]

virtual void VOP_SubnetOutput::preOpChanged ( OP_EventType  reason,
void *  data 
) [protected, virtual]

Reimplemented from VOP_Node.

virtual OP_ERROR VOP_SubnetOutput::setInput ( unsigned  idx,
OP_Node op,
unsigned  outputIdx = 0 
) [virtual]

Override the setInput functions so that we can send notification to the nodes that are our inputs when we disconnect from them.

Reimplemented from VOP_Node.

virtual OP_ERROR VOP_SubnetOutput::setInputReference ( unsigned  idx,
const char *  label,
int  keeppos,
unsigned  outputIdx = 0 
) [virtual]

Connects an input to particular node by name in the network.

Reimplemented from VOP_Node.

virtual void VOP_SubnetOutput::setLABELFROMPARM ( UT_String str,
int  idx 
) [virtual]

virtual void VOP_SubnetOutput::setNAMEFROMPARM ( UT_String str,
int  idx 
) [virtual]


Member Data Documentation

Definition at line 30 of file VOP_SubnetOutput.h.


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

Generated on Mon Jan 28 00:30:24 2013 for HDK by  doxygen 1.5.9