HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
apex::APEX_FunctionBase Class Referenceabstract

#include <APEX_Callback.h>

+ Inheritance diagram for apex::APEX_FunctionBase:

Public Member Functions

virtual ~APEX_FunctionBase ()=default
 
virtual const UT_StringHoldergetName () const =0
 
virtual void compile (const APEX_Graph *graph, APEX_NodeID node_id, APEX_Program *prog, UT_Array< APEX_Argument > &args) const
 
virtual void execute (APEX_ArgPtrs &arg_ptrs) const
 
virtual APEX_CallbackType callbackType () const
 What kind of function is this? Informs things like scopes & conditions. More...
 
virtual const APEX_Signaturesignature () const =0
 
virtual const
APEX_TypeDefinitionBase
runDataTypeDef () const
 
virtual const char * minProductVersion () const
 Earliest Houdini version that this callback is allowed in "X.Y.Z" format. More...
 
virtual bool isHidden () const
 Determines whether the callback should be hidden from the UI. More...
 
virtual bool requiresCEFlush () const
 Whether the callback requires its input geometry CE caches to be flushed. More...
 
virtual bool usesCE () const
 Whether the callback leaves CE caches in its output geometry. More...
 
virtual void runDataCompileHook (APEX_Argument *rundata_instance, const APEX_Graph *in_graph, APEX_NodeID for_node, APEX_Program *bind_to) const
 Called for any type with rundata with a reference to the rundata so it can be initialized. More...
 
bool opensScope () const
 Does this node open a scope? More...
 
bool closesScope () const
 Does this node close a scope? More...
 
virtual UT_StringHolder scopeConnection () const
 Name of the fake wire which is used to denote scope relationships. More...
 
virtual bool hasSubnetTemplate () const
 
virtual const DictparmDefaults () const
 

Detailed Description

Definition at line 410 of file APEX_Callback.h.

Constructor & Destructor Documentation

virtual apex::APEX_FunctionBase::~APEX_FunctionBase ( )
virtualdefault

Member Function Documentation

virtual APEX_CallbackType apex::APEX_FunctionBase::callbackType ( ) const
inlinevirtual

What kind of function is this? Informs things like scopes & conditions.

Reimplemented in apex::APEX_GenericFunction< C, Ts >, apex::APEX_GenericFunctionContext< C, Ts >, and apex::APEX_GenericFunctionRunData< C, Ts >.

Definition at line 426 of file APEX_Callback.h.

bool apex::APEX_FunctionBase::closesScope ( ) const
inline

Does this node close a scope?

Definition at line 461 of file APEX_Callback.h.

virtual void apex::APEX_FunctionBase::compile ( const APEX_Graph *  graph,
APEX_NodeID  node_id,
APEX_Program *  prog,
UT_Array< APEX_Argument > &  args 
) const
inlinevirtual

Definition at line 416 of file APEX_Callback.h.

virtual void apex::APEX_FunctionBase::execute ( APEX_ArgPtrs arg_ptrs) const
inlinevirtual
virtual const UT_StringHolder& apex::APEX_FunctionBase::getName ( ) const
pure virtual
virtual bool apex::APEX_FunctionBase::hasSubnetTemplate ( ) const
inlinevirtual

Definition at line 470 of file APEX_Callback.h.

virtual bool apex::APEX_FunctionBase::isHidden ( ) const
inlinevirtual

Determines whether the callback should be hidden from the UI.

Definition at line 436 of file APEX_Callback.h.

virtual const char* apex::APEX_FunctionBase::minProductVersion ( ) const
inlinevirtual

Earliest Houdini version that this callback is allowed in "X.Y.Z" format.

Definition at line 433 of file APEX_Callback.h.

bool apex::APEX_FunctionBase::opensScope ( ) const
inline

Does this node open a scope?

Definition at line 454 of file APEX_Callback.h.

virtual const Dict& apex::APEX_FunctionBase::parmDefaults ( ) const
inlinevirtual
virtual bool apex::APEX_FunctionBase::requiresCEFlush ( ) const
inlinevirtual

Whether the callback requires its input geometry CE caches to be flushed.

Definition at line 439 of file APEX_Callback.h.

virtual void apex::APEX_FunctionBase::runDataCompileHook ( APEX_Argument rundata_instance,
const APEX_Graph *  in_graph,
APEX_NodeID  for_node,
APEX_Program *  bind_to 
) const
inlinevirtual

Called for any type with rundata with a reference to the rundata so it can be initialized.

Reimplemented in apex::APEX_GenericFunctionContext< C, Ts >, and apex::APEX_GenericFunctionRunData< C, Ts >.

Definition at line 445 of file APEX_Callback.h.

virtual const APEX_TypeDefinitionBase* apex::APEX_FunctionBase::runDataTypeDef ( ) const
inlinevirtual
virtual UT_StringHolder apex::APEX_FunctionBase::scopeConnection ( ) const
inlinevirtual

Name of the fake wire which is used to denote scope relationships.

Definition at line 468 of file APEX_Callback.h.

virtual const APEX_Signature& apex::APEX_FunctionBase::signature ( ) const
pure virtual
virtual bool apex::APEX_FunctionBase::usesCE ( ) const
inlinevirtual

Whether the callback leaves CE caches in its output geometry.

Definition at line 442 of file APEX_Callback.h.


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