Click or drag to resize

IGH_Param Methods

The IGH_Param type exposes the following members.

Methods
  NameDescription
Public methodAddRuntimeMessage
Add a new message to this object. Valid message type flags are Warning and Error. If the Message string is empty or zero-length no message is added.
(Inherited from IGH_ActiveObject.)
Public methodAddSource(IGH_Param)
Append a new Source parameter to the end of the Sources list. Sources provide this parameter with data at runtime.
Public methodAddSource(IGH_Param, Int32)
Insert a new Source parameter into the Sources list. Sources provide this parameter with data at runtime.
Public methodAddVolatileData
Inserts an item of volatile data into the data structure.
Public methodAddVolatileDataList
Inserts a list of items into the data structure.
Public methodAddVolatileDataTree
Insert an entire data tree into this parameter.
Public methodClearData
This function is called whenever the object needs to clear all solution data. This usually amounts to wiping volatile caches and messages. This function will not affect any other objects, but it will set the Phase flag to Blank
(Inherited from IGH_ActiveObject.)
Public methodClearProxySources
Remove all proxy sources without attempting to relink them.
Public methodClearRuntimeMessages
Clear all message lists.
(Inherited from IGH_ActiveObject.)
Public methodCollectData
This function is called whenever the object is required to collect all data. Either from Persistent records, from source params or whatever. This step is only performed if the phase flag is Blank or Failed. Upon completion, the phase flag will be set to Collected
(Inherited from IGH_ActiveObject.)
Public methodComputeData
This function is called whenever the object is required to generate new data. This step is only performed by some objects and only when the Phase flag is Collected. Upon completion, the Phase will be Computed. If this object throws exceptions, it is the responsibility of the caller to set the Phase flag to Failed.
(Inherited from IGH_ActiveObject.)
Public methodCreateProxySources
Convert all proper source parameters into proxy sources.
Public methodDependsOn
Solve the inheritance relationship between this object and a potential parental object.
(Inherited from IGH_ActiveObject.)
Public methodRegisterRemoteIDs
If this object depends on Rhino Objects, you must register the UUIDs of those objects. Failure to do so will result in faulty event handling.
(Inherited from IGH_ActiveObject.)
Public methodRelinkProxySources
Attempt to replace all proxy sources with real sources. Proxy sources are used during file IO, when actual sources might not be available yet. Once an IO operation has been completed there should be no more proxy sources.
Public methodRemoveAllSources
Remove all sources from this parameter.
Public methodRemoveEffects
Remove all post-process effects.
Public methodRemoveSource(Guid)
Remove the specified source from this parameter.
Public methodRemoveSource(IGH_Param)
Remove the specified source from this parameter.
Public methodReplaceSource(Guid, IGH_Param)
Replace an existing source with a new one. If the old_source does not exist in this parameter, nothing happens.
Public methodReplaceSource(IGH_Param, IGH_Param)
Replace an existing source with a new one. If the old_source does not exist in this parameter, nothing happens.
Public methodRuntimeMessages
Gets the list of cached runtime messages that were recorded during solver-time processes.
(Inherited from IGH_ActiveObject.)
Public methodSDKCompliancy
Test whether this object is compliant with a given Rhino version.
(Inherited from IGH_ActiveObject.)
Top
See Also