Karamba3D API Reference
Component_
GH-component that eliminates identical points from the given set of points.
Definition
Namespace: Karamba.GHopper.Utilities
Assembly: karamba (in karamba.dll) Version: 1.0.0+eb23a7103f0eca0b6d808121e15fec6899194e15
Assembly: karamba (in karamba.dll) Version: 1.0.0+eb23a7103f0eca0b6d808121e15fec6899194e15
C#
public class Component_RemoveDuplicatePoints : GH_ComponentVB
Public Class Component_RemoveDuplicatePoints
Inherits GH_ComponentC++
public ref class Component_RemoveDuplicatePoints : public GH_ComponentF#
type Component_RemoveDuplicatePoints =
class
inherit GH_Component
end- Inheritance
- Object GH_InstanceDescription GH_DocumentObject GH_ActiveObject GH_Component Component_RemoveDuplicatePoints
Constructors
| Component_RemoveDuplicatePoints | Initializes a new instance of the Component_RemoveDuplicatePoints class. |
Properties
| Attributes |
Gets or sets the attributes that are associated with this object.
Only set custom attributes if you know what you are doing.
(Inherited from GH_DocumentObject) |
| Category |
Gets or sets the Category in which this object belongs. If HasCategory() returns false, this field has no meaning.
(Inherited from GH_InstanceDescription) |
| ClippingBox |
Gets the clipping box for all preview geometry drawn by this component
and all associated parameters.
(Inherited from GH_Component) |
| ComponentGuid |
Returns a consistent ID for this object type. Every object must supply a unique and unchanging
ID that is used to identify objects of the same type.
(Overrides GH_DocumentObject.ComponentGuid) |
| Description |
Gets or sets the description of the object. This field typically remains fixed during the lifetime of an object.
(Inherited from GH_InstanceDescription) |
| Exposure |
Gets the exposure of this object in the Graphical User Interface.
The default is to expose everywhere.
(Overrides GH_DocumentObject.Exposure) |
| HasCategory |
Gets whether or not the Category field has been set.
(Inherited from GH_InstanceDescription) |
| HasSubCategory |
Gets whether or not the SubCategory field has been set.
(Inherited from GH_InstanceDescription) |
| HelpDescription |
Override this method if you want the help topic content to be more than the Component description.
(Inherited from GH_Component) |
| Hidden |
Gets or sets the hidden flag for this component.
Does not affect Hidden flags on parameters associated
with this component.
(Inherited from GH_Component) |
| Icon |
Override this function to supply a custom icon (24x24 pixels). The result of this property is cached,
so don't worry if icon retrieval is not very fast.
(Overrides GH_DocumentObject.Icon) |
| Icon_24x24 |
The icon associated with this object.
(Inherited from GH_DocumentObject) |
| Icon_24x24_Locked |
The greyscale icon of this object.
(Inherited from GH_DocumentObject) |
| IconCapableUI |
By default the NickName menu item supports the Icon Mode override toggle.
If your UI is not capable of displaying icons, then override this property
and return False.
(Inherited from GH_ActiveObject) |
| IconDisplayMode |
Gets the current display mode of the object.
(Inherited from GH_DocumentObject) |
| InConstructor |
Gets the constructor flag for this instance. If InConstructor = True,
it means the component is still registering parameters and the
layout is not yet complete.
(Inherited from GH_Component) |
| InstanceDescription |
(Inherited from GH_Component) |
| InstanceGuid |
Gets the ID of this runtime instance.
(Inherited from GH_InstanceDescription) |
| IsBakeCapable |
(Inherited from GH_Component) |
| IsDataProvider |
Components are never Data providers. Only the output parameters can be considered to be providers.
(Inherited from GH_Component) |
| IsPreviewCapable |
If a single parameter is PreviewCapable, so is the component.
Override this property if you need special Preview flags.
(Inherited from GH_Component) |
| IsValidPrincipalParameterIndex |
Gets whether the MasterParameterIndex property identifies a valid parameter.
(Inherited from GH_Component) |
| Keywords |
Gets a list of additional keywords that describe the object. Typically this list is empty but you
can override this property to aid in object searches.
(Inherited from GH_InstanceDescription) |
| Locked |
Gets or sets the Locked state for this Component.
This also sets locked states for all input and output parameters.
(Inherited from GH_Component) |
| Message |
Gets or sets a custom message to be displayed underneath the component.
This message is not serialized and should be assigned on every solution anew.
(Inherited from GH_Component) |
| MutableNickName |
Gets or sets a value that enables Nick name changes through the menu.
The default is TRUE.
(Inherited from GH_ActiveObject) |
| Name |
Gets or sets the name of the object. This field typically remains fixed during the lifetime of an object.
(Inherited from GH_InstanceDescription) |
| NickName |
Gets or sets the nickname of the object. This field can be changed by the user.
(Inherited from GH_InstanceDescription) |
| Obsolete |
Gets whether this object is obsolete. Default implementation returns true if
the class name contains the string "OBSOLETE" or if this class has been decorated with the
ObsoleteAttribute.
You are free to override this if you want, but I suggest adding the ObsoleteAttribute instead.
(Inherited from GH_DocumentObject) |
| Params |
Gets the parameter manager object for this component.
(Inherited from GH_Component) |
| Phase |
Gets or sets the solution phase this object is currenly in.
(Inherited from GH_ActiveObject) |
| PrincipalParameterIndex |
Gets or sets the principal parameter index override.
Negative indices or indices larger than or equal to the input parameter count will
be ignored and regular principal parameter detection will kick in.
(Inherited from GH_Component) |
| ProcessorTime |
Gets the total processor time (profiler) spend by this component and all input parameters.
(Inherited from GH_Component) |
| RunCount |
Gets a value indicating how many times the SolveInstance method was called on this component during the last solution.
This property will return -1 if no valid runcount is available.
(Inherited from GH_Component) |
| RuntimeMessageLevel |
Returns the worst case runtime warning level of me and all my parameters
(Inherited from GH_Component) |
| SubCategory |
Gets or sets the SubCategory in which this object belongs. If HasSubCategory() returns false, this field has no meaning.
(Inherited from GH_InstanceDescription) |
Methods
| AddedToDocument |
Overrides the AddedToDocument method and delegates the call to all parameters.
(Inherited from GH_Component) |
| AddRuntimeMessage |
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 GH_ActiveObject) |
| AfterSolveInstance |
Override this method if you want to be called
after the last call to SolveInstance.
(Inherited from GH_Component) |
| AppendAdditionalComponentMenuItems |
Override this function if you want to insert some custom menu items in your derived Component class.
Items will be added between List Matching items and parameter menus.
(Inherited from GH_Component) |
| AppendAdditionalMenuItems |
Adds typical component type items to the context menu:
1. Data comparison types
2. Custom (overridden) items
3. Nested input parameter context menu items
4. Nested output parameter context menu items
(Inherited from GH_Component) |
| AppendMenuItems |
This function is called when a context menu is about to be displayed.
Override it to set custom items. GH_ActiveObject will already populate
the menu with default items, if you merely wish to insert object-specific
menu item, consider overriding AppendAdditionalMenuItems instead.
(Inherited from GH_ActiveObject) |
| AssignInitCodeToInputParameter |
Utility function for parsing and assigning init codes. This only works for standard parameter types.
(Inherited from GH_Component) |
| BakeGeometry(RhinoDoc, ListGuid) |
(Inherited from GH_Component) |
| BakeGeometry(RhinoDoc, ObjectAttributes, ListGuid) |
(Inherited from GH_Component) |
| BeforeSolveInstance |
Override this method if you want to be called
before the first call to SolveInstance.
(Inherited from GH_Component) |
| ClearData |
Clear the data inside this component and all output parameters.
(Inherited from GH_Component) |
| ClearRuntimeMessages |
Clears all runtime messages in me and my parameters
(Inherited from GH_Component) |
| CollectData |
Calls CollectData on all input parameters and makes sure the
Component and all associated parameters are left in a valid state.
(Inherited from GH_Component) |
| ComputeData |
Compute all data and fill out all output parameters.
(Inherited from GH_Component) |
| CopyFrom |
Copy all fields (except the instance ID) from another instance description.
(Inherited from GH_InstanceDescription) |
| CreateAttributes |
Create new attributes.
(Inherited from GH_Component) |
| DependsOn |
Returns True is any one of my input parameters depends on the source.
(Inherited from GH_Component) |
| DestroyIconCache |
Call this method to erase the existing icon cache.
You must call this if you want to change the display icon of an object.
(Inherited from GH_DocumentObject) |
| DocumentContextChanged |
Overrides the DocumentContextChanged method and delegates the call to all parameters.
(Inherited from GH_Component) |
| DrawViewportMeshes |
Draw preview meshes for this component and all associated parameters.
(Inherited from GH_Component) |
| DrawViewportWires |
Draw preview wires for this component and all associated parameters.
(Inherited from GH_Component) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExpireDownStreamObjects |
Expire all objects that depend on any of the output parameters.
(Inherited from GH_Component) |
| ExpirePreview |
Call this function when you suspect that the preview has expired for this object.
This will cause the display cache to be eradicated.
(Inherited from GH_DocumentObject) |
| ExpireSolution |
Informs the document that owns this object that the solution has expired.
The current object will be set to BLANK as a result. This method is recursive,
it will also expire any and all objects which depend on this object.
If you want a less destructive expiration, consider using ClearData().
If this object is already Blank, you should consider not expiring it.
(Inherited from GH_ActiveObject) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GenerateDefaultHTML |
Creates the default component help topic, including all parameter lists.
(Inherited from GH_Component) |
| GenerateParameterHelp |
Create an HTML string that lists names and descriptions for input and output parameters.
(Inherited from GH_Component) |
| GenerateParameterHelp(IGH_Param) |
Generate HTML string for a single parameter.
(Inherited from GH_Component) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValue(String, Boolean) |
Get a boolean value from the component value table.
(Inherited from GH_DocumentObject) |
| GetValue(String, Double) |
Get a double value from the component value table.
(Inherited from GH_DocumentObject) |
| GetValue(String, Color) |
Get a color value from the component value table.
(Inherited from GH_DocumentObject) |
| GetValue(String, Int32) |
Get an integer value from the component value table.
(Inherited from GH_DocumentObject) |
| GetValue(String, String) |
Get a string value from the component value table.
(Inherited from GH_DocumentObject) |
| HtmlHelp_Source |
Return a String which contains HTML formatted source for the help topic.
If you want to pass a URL that points to a remote page, then prefix the URL with a GOTO: tag, like so:
GOTO:http://www.YourWebAddressHere.com
(Inherited from GH_Component) |
| IsolateObject |
Sever the connections of all input and output parameters.
(Inherited from GH_Component) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Menu_AppendBakeItem |
Append the default Bake menu item.
(Inherited from GH_ActiveObject) |
| Menu_AppendEnableItem |
Append the default Enable/Disable menu item.
(Inherited from GH_ActiveObject) |
| Menu_AppendObjectHelp |
Appends the default object Help menu item.
(Inherited from GH_DocumentObject) |
| Menu_AppendObjectName |
Appends the old-fashioned object name menu item. If you also want the
Display mode toggle then use Menu_AppendObjectNameEx()
(Inherited from GH_DocumentObject) |
| Menu_AppendObjectNameEx |
Appends the default object name + display mode menu item.
(Inherited from GH_DocumentObject) |
| Menu_AppendPreviewItem |
Append the default Show/Hide preview menu item.
(Inherited from GH_ActiveObject) |
| Menu_AppendPublish |
Appends the default item for publishing to RCP.
This menu will only appear if the current class implement IRcpAwareObject
(Inherited from GH_DocumentObject) |
| Menu_AppendRuntimeMessages |
Append the default warnings and errors menu items.
(Inherited from GH_ActiveObject) |
| MovedBetweenDocuments |
Overrides the MovedBetweenDocuments method and delegates the call to all parameters.
(Inherited from GH_Component) |
| NewInstanceGuid |
Generate a new random instance GUID
(Inherited from GH_InstanceDescription) |
| NewInstanceGuid(Guid) |
Set the instance ID to be a specific GUID. This is very dangerous, only use this function
if you're 6"4' and your first name is David.
(Inherited from GH_InstanceDescription) |
| OnAttributesChanged |
Raises the AttributesChanged event on the toplevel object.
(Inherited from GH_DocumentObject) |
| OnDisplayExpired |
Raises the DisplayExpired event on the toplevel object.
(Inherited from GH_DocumentObject) |
| OnObjectChanged(GH_ObjectChangedEventArgs) |
(Inherited from GH_DocumentObject) |
| OnObjectChanged(GH_ObjectEventType) |
(Inherited from GH_DocumentObject) |
| OnObjectChanged(String) |
(Inherited from GH_DocumentObject) |
| OnObjectChanged(GH_ObjectEventType, Object) |
(Inherited from GH_DocumentObject) |
| OnObjectChanged(String, Object) |
(Inherited from GH_DocumentObject) |
| OnPingDocument |
Raise the PingDocument Event on the toplevel object and try to find
the document which owns this object.
(Inherited from GH_DocumentObject) |
| OnPreviewExpired |
Raises the PreviewExpired event on the toplevel object.
(Inherited from GH_DocumentObject) |
| OnSolutionExpired |
Raises the SolutionExpired event on the toplevel object.
You probably want to call ExpireSolution() instead of this method directly.
(Inherited from GH_DocumentObject) |
| PostConstructor |
The PostConstructor is called from within each constructor.
DO NOT OVERRIDE THIS unless you know what you are doing.
(Inherited from GH_Component) |
| Read |
Read all required data for deserialization from an IO archive.
(Inherited from GH_Component) |
| ReadFull |
GH_InstanceDescription does not by default serialize all fields.
Use this function to read all fields from the archive.
This method is compatible with the default Write()/Read() operations.
(Inherited from GH_InstanceDescription) |
| RecordUndoEvent(GH_UndoRecord) |
Record an entire undo record.
(Inherited from GH_DocumentObject) |
| RecordUndoEvent(String) |
Record a generic object change undo event.
(Inherited from GH_DocumentObject) |
| RecordUndoEvent(String, IGH_UndoAction) |
Record a specific object change undo event.
(Inherited from GH_DocumentObject) |
| RegisterInputParams |
Declare all your input parameters here.
(Overrides GH_Component.RegisterInputParams(GH_InputParamManager)) |
| RegisterOutputParams |
Declare all your output parameters here.
(Overrides GH_Component.RegisterOutputParams(GH_OutputParamManager)) |
| RegisterRemoteIDs |
Registers all my input parameters with the UUID_LookUpTable
(Inherited from GH_Component) |
| RemovedFromDocument |
Overrides the RemovedFromDocument method and delegates the call to all parameters.
(Inherited from GH_Component) |
| RuntimeMessages |
Gets the list of cached runtime messages that were recorded during solver-time processes.
For components, the set of runtime messages also includes input and output parameters.
(Inherited from GH_Component) |
| SDKCompliancy |
Test whether this object is compliant with a given Rhino version.
(Inherited from GH_ActiveObject) |
| SetIconOverride |
Set a new custom icon override for this object.
(Inherited from GH_DocumentObject) |
| SetValue(String, Boolean) |
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject) |
| SetValue(String, Double) |
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject) |
| SetValue(String, Color) |
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject) |
| SetValue(String, Int32) |
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject) |
| SetValue(String, String) |
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject) |
| SolveInstance |
This function will be called (successively) from within the
ComputeData method of this component.
(Overrides GH_Component.SolveInstance(IGH_DataAccess)) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TriggerAutoSave |
Triggers the AutoSave function on the owner document with the object_changed flag.
(Inherited from GH_DocumentObject) |
| TriggerAutoSave(GH_AutoSaveTrigger) |
Triggers the AutoSave function on the owner document with a custom flag.
(Inherited from GH_DocumentObject) |
| TriggerAutoSave(Guid) |
Triggers the AutoSave function on the owner document with the object_changed flag.
(Inherited from GH_DocumentObject) |
| TriggerAutoSave(GH_AutoSaveTrigger, Guid) |
Triggers the AutoSave function on the owner document with a custom flag.
(Inherited from GH_DocumentObject) |
| ValuesChanged |
Override this method if you want to respond to changes to the value table.
The base implementation is empty, so you don't have to call it.
(Inherited from GH_DocumentObject) |
| Write |
Write all required data for deserialization to an IO archive.
(Inherited from GH_Component) |
| WriteFull |
GH_InstanceDescription does not by default serialize all fields.
Use this function to write all fields to the archive.
This method is compatible with the default Write()/Read() operations.
(Inherited from GH_InstanceDescription) |
Events
| AttributesChanged |
Raised whenever the number or kind of attributes changes. This event is handled
by GH_Documents who subsequently wipe their attribute caches.
(Inherited from GH_DocumentObject) |
| DisplayExpired |
Raised whenever the display (on the Canvas) of a certain object becomes invalid.
(Inherited from GH_DocumentObject) |
| ObjectChanged |
(Inherited from GH_DocumentObject) |
| PingDocument |
Raised whenever an object needs to know which GH_Document it belongs to.
(Inherited from GH_DocumentObject) |
| PreviewExpired |
Raised whenever the display (in the Rhino viewports) of a certain object becomes invalid.
(Inherited from GH_DocumentObject) |
| SolutionExpired |
Raised whenever the solution of a certain object becomes invalid.
(Inherited from GH_DocumentObject) |
Fields
| m_attributes |
(Inherited from GH_DocumentObject) |
Extension Methods
| ContainerType |
test if object is (a container like) a list or an array.
(Defined by MiniUtil) |