Class ControlPoint#

main - nodes - nodes menus

Vertex is one of the two domains of Curve.

It uses the ‘POINT’ string domain.

Constructor#

ControlPoint(self, data_socket, selection=None)

Args:#

data_socket (DataSocket): the data class the domain belongs to
selection (any): the selection to use

Content#

Properties

Class and static methods

random_boolean | random_float | random_integer | random_vector

Methods

Properties#

ID#

Node: ID | Blender reference | api reference

Returns:#

socket ID

Setter

Node: Set ID | Blender reference | api reference

Node implemented as property setter.

Args:#

attr_value: ID

_{Go to top - main - nodes - nodes menus}

as_cloud_points#

Type cast to CloudPoint.

_{Go to top - main - nodes - nodes menus}

as_control_points#

Type cast to ControlPoint.

_{Go to top - main - nodes - nodes menus}

as_corners#

Type cast to Corner.

_{Go to top - main - nodes - nodes menus}

as_edges#

Type cast to Edge.

_{Go to top - main - nodes - nodes menus}

as_faces#

Type cast to Face.

_{Go to top - main - nodes - nodes menus}

as_insts#

Type cast to Instance.

_{Go to top - main - nodes - nodes menus}

as_splines#

Type cast to Spline.

_{Go to top - main - nodes - nodes menus}

as_verts#

Type cast to Vertex.

_{Go to top - main - nodes - nodes menus}

count#

Node: Domain Size | Blender reference | api reference

Returns:#

socket point_count

_{Go to top - main - nodes - nodes menus}

data_socket#

Returns the data socket it belongs to.

Returns:#

DataSocket

_{Go to top - main - nodes - nodes menus}

domain#

Gives the Geometry Nodes domain string to use in the generated nodes.

Vertex : ‘POINT’,
Edge : ‘EDGE’,
Face : ‘FACE’,
Corner : ‘CORNER’,
ControlPoint : ‘POINT’,
Spline : ‘CURVE’,
CloudPoint : ‘POINT’,
Instance : ‘INSTANCE’,

Returns:#

domain string (str)

_{Go to top - main - nodes - nodes menus}

domain_index#

Node: Index | Blender reference | api reference

Returns:#

socket index

_{Go to top - main - nodes - nodes menus}

index#

Node: Index | Blender reference | api reference

Returns:#

socket index

_{Go to top - main - nodes - nodes menus}

left_handle_positions#

Node: Curve Handle Positions | Blender reference | api reference

Returns:#

socket left

Setter

Node: Set Handle Positions | Blender reference | api reference

Node implemented as property setter.

Args:#

attr_value: position

_{Go to top - main - nodes - nodes menus}

normal#

Node: Normal | Blender reference | api reference

Returns:#

socket normal

_{Go to top - main - nodes - nodes menus}

parameter#

Node: Spline Parameter | Blender reference | api reference

Node Image

Returns:#

tuple (’factor’, ‘length’, ‘index’)

_{Go to top - main - nodes - nodes menus}

parameter_factor#

Node: Spline Parameter | Blender reference | api reference

Returns:#

socket factor

_{Go to top - main - nodes - nodes menus}

parameter_index#

Node: Spline Parameter | Blender reference | api reference

Returns:#

socket index

_{Go to top - main - nodes - nodes menus}

parameter_length#

Node: Spline Parameter | Blender reference | api reference

Returns:#

socket length

_{Go to top - main - nodes - nodes menus}

position#

Node: Position | Blender reference | api reference

Returns:#

socket position

Setter

Node: Set Position | Blender reference | api reference

Node implemented as property setter.

Args:#

attr_value: position

_{Go to top - main - nodes - nodes menus}

radius#

Node: Radius | Blender reference | api reference

Returns:#

socket radius

Setter

Node: Set Curve Radius | Blender reference | api reference

Node implemented as property setter.

Args:#

attr_value: radius

_{Go to top - main - nodes - nodes menus}

right_handle_positions#

Node: Curve Handle Positions | Blender reference | api reference

Returns:#

socket right

Setter

Node: Set Handle Positions | Blender reference | api reference

Node implemented as property setter.

Args:#

attr_value: position

_{Go to top - main - nodes - nodes menus}

selection#

Returns the selection value to use in nodes with a Selection socket.

Returns:#

Boolean

_{Go to top - main - nodes - nodes menus}

selection_index#

Returns the selection index.

CAUTION: raise an error if the selection is not a integer.

Returns:#

Integer

_{Go to top - main - nodes - nodes menus}

tangent#

Node: Curve Tangent | Blender reference | api reference

Returns:#

socket tangent

_{Go to top - main - nodes - nodes menus}

tilt#

Node: Curve Tilt | Blender reference | api reference

Returns:#

socket tilt

Setter

Node: Set Curve Tilt | Blender reference | api reference

Node implemented as property setter.

Args:#

attr_value: tilt

_{Go to top - main - nodes - nodes menus}

Class and static methods#

random_boolean#

@staticmethod
def random_boolean(probability=None, ID=None, seed=None)

Node: Random Value | Blender reference | api reference

Args:#

probability: Float
ID: Integer
seed: Integer

Returns:#

socket value

_{Go to top - main - nodes - nodes menus}

random_float#

@staticmethod
def random_float(min=None, max=None, ID=None, seed=None)

Node: Random Value | Blender reference | api reference

Args:#

min: [‘Vector’, ‘Float’, ‘Integer’]
max: [‘Vector’, ‘Float’, ‘Integer’]
ID: Integer
seed: Integer

Returns:#

socket value

_{Go to top - main - nodes - nodes menus}

random_integer#

@staticmethod
def random_integer(min=None, max=None, ID=None, seed=None)

Node: Random Value | Blender reference | api reference

Args:#

min: [‘Vector’, ‘Float’, ‘Integer’]
max: [‘Vector’, ‘Float’, ‘Integer’]
ID: Integer
seed: Integer

Returns:#

socket value

_{Go to top - main - nodes - nodes menus}

random_vector#

@staticmethod
def random_vector(min=None, max=None, ID=None, seed=None)

Node: Random Value | Blender reference | api reference

Args:#

min: [‘Vector’, ‘Float’, ‘Integer’]
max: [‘Vector’, ‘Float’, ‘Integer’]
ID: Integer
seed: Integer

Returns:#

socket value

_{Go to top - main - nodes - nodes menus}

Methods#

accumulate_field#

def accumulate_field(self, value=None, group_index=None)

Node: Accumulate Field | Blender reference | api reference

Args:#

value: [‘Vector’, ‘Float’, ‘Integer’]
group_index: Integer

Node Image

Returns:#

tuple (’leading’, ‘trailing’, ‘total’)

_{Go to top - main - nodes - nodes menus}

attribute_max#

def attribute_max(self, attribute=None)

Node: Attribute Statistic | Blender reference | api reference

Args:#

attribute: [‘Float’, ‘Vector’]

Returns:#

socket max

_{Go to top - main - nodes - nodes menus}

attribute_mean#

def attribute_mean(self, attribute=None)

Node: Attribute Statistic | Blender reference | api reference

Args:#

attribute: [‘Float’, ‘Vector’]

Returns:#

socket mean

_{Go to top - main - nodes - nodes menus}

attribute_median#

def attribute_median(self, attribute=None)

Node: Attribute Statistic | Blender reference | api reference

Args:#

attribute: [‘Float’, ‘Vector’]

Returns:#

socket median

_{Go to top - main - nodes - nodes menus}

attribute_min#

def attribute_min(self, attribute=None)

Node: Attribute Statistic | Blender reference | api reference

Args:#

attribute: [‘Float’, ‘Vector’]

Returns:#

socket min

_{Go to top - main - nodes - nodes menus}

attribute_node#

def attribute_node(self, node)

Define an input node as attribute

Called when creating an input node in a property getter. Performs two actions:

- Call the method :func:`Node.as_attribute` to tag the node as being an attribute.
  This will allow the :func:`Tree.check_attributes` to see if it is necessary to create
  a *Capture Attribute* for this field.
- Set the nde property :attr:`field_of` to self in order to implement the transfer attribute
  mechanism.

Args:#

node (Node): The node created by the domain

Returns:#

The node argument

_{Go to top - main - nodes - nodes menus}

attribute_range#

def attribute_range(self, attribute=None)

Node: Attribute Statistic | Blender reference | api reference

Args:#

attribute: [‘Float’, ‘Vector’]

Returns:#

socket range

_{Go to top - main - nodes - nodes menus}

attribute_statistic#

def attribute_statistic(self, attribute=None)

Node: Attribute Statistic | Blender reference | api reference

Args:#

attribute: [‘Float’, ‘Vector’]

Returns:#

node with sockets [‘mean’, ‘median’, ‘sum’, ‘min’, ‘max’, ‘range’, ‘standard_deviation’, ‘variance’]

_{Go to top - main - nodes - nodes menus}

attribute_std#

def attribute_std(self, attribute=None)

Node: Attribute Statistic | Blender reference | api reference

Args:#

attribute: [‘Float’, ‘Vector’]

Returns:#

socket standard_deviation

_{Go to top - main - nodes - nodes menus}

attribute_sum#

def attribute_sum(self, attribute=None)

Node: Attribute Statistic | Blender reference | api reference

Args:#

attribute: [‘Float’, ‘Vector’]

Returns:#

socket sum

_{Go to top - main - nodes - nodes menus}

attribute_var#

def attribute_var(self, attribute=None)

Node: Attribute Statistic | Blender reference | api reference

Args:#

attribute: [‘Float’, ‘Vector’]

Returns:#

socket variance

_{Go to top - main - nodes - nodes menus}

capture_attribute#

def capture_attribute(self, value=None)

Node: Capture Attribute | Blender reference | api reference

Args:#

value: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

curve#

def curve(self)

Node: Curve of Point | Blender reference | api reference

Node Image

Returns:#

tuple (’curve_index’, ‘index_in_curve’)

_{Go to top - main - nodes - nodes menus}

delete#

def delete(self, mode='ALL')

Node: Delete Geometry | Blender reference | api reference

Args:#

mode (str): ‘ALL’ in [ALL, EDGE_FACE, ONLY_FACE]

Returns:#

self

_{Go to top - main - nodes - nodes menus}

duplicate#

def duplicate(self, amount=None)

Node: Duplicate Elements | Blender reference | api reference

Args:#

amount: Integer

Returns:#

socket duplicate_index

_{Go to top - main - nodes - nodes menus}

endpoint_selection#

def endpoint_selection(self, start_size=None, end_size=None)

Node: Endpoint Selection | Blender reference | api reference

Args:#

start_size: Integer
end_size: Integer

Returns:#

socket selection

_{Go to top - main - nodes - nodes menus}

field_at_index#

def field_at_index(self, index=None, value=None)

Node: Field at Index | Blender reference | api reference

Args:#

index: Integer
value: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘Boolean’]

Returns:#

socket value

_{Go to top - main - nodes - nodes menus}

handle_positions#

def handle_positions(self, relative=None)

Node: Curve Handle Positions | Blender reference | api reference

Args:#

relative: Boolean

Returns:#

node with sockets [‘left’, ‘right’]

_{Go to top - main - nodes - nodes menus}

handle_type_selection#

def handle_type_selection(self, left=True, right=True, handle_type='AUTO')

Node: Handle Type Selection | Blender reference | api reference

Args:#

handle_type (str): ‘AUTO’ in [FREE, AUTO, VECTOR, ALIGN]
mode (set): {‘RIGHT’, ‘LEFT’}

Returns:#

node with sockets [‘selection’]

_{Go to top - main - nodes - nodes menus}

handle_type_selection_align#

def handle_type_selection_align(self, left=True, right=True)

Node: Handle Type Selection | Blender reference | api reference

Args:#

handle_type (str): ‘AUTO’ in [FREE, AUTO, VECTOR, ALIGN]
mode (set): {‘RIGHT’, ‘LEFT’}

Returns:#

node with sockets [‘selection’]

_{Go to top - main - nodes - nodes menus}

handle_type_selection_auto#

def handle_type_selection_auto(self, left=True, right=True)

Node: Handle Type Selection | Blender reference | api reference

Args:#

handle_type (str): ‘AUTO’ in [FREE, AUTO, VECTOR, ALIGN]
mode (set): {‘RIGHT’, ‘LEFT’}

Returns:#

node with sockets [‘selection’]

_{Go to top - main - nodes - nodes menus}

handle_type_selection_free#

def handle_type_selection_free(self, left=True, right=True)

Node: Handle Type Selection | Blender reference | api reference

Args:#

handle_type (str): ‘AUTO’ in [FREE, AUTO, VECTOR, ALIGN]
mode (set): {‘RIGHT’, ‘LEFT’}

Returns:#

node with sockets [‘selection’]

_{Go to top - main - nodes - nodes menus}

handle_type_selection_node#

def handle_type_selection_node(self, handle_type='AUTO', mode={'RIGHT', 'LEFT'})

Node: Handle Type Selection | Blender reference | api reference

Args:#

handle_type (str): ‘AUTO’ in [FREE, AUTO, VECTOR, ALIGN]
mode (set): {‘RIGHT’, ‘LEFT’}

Returns:#

socket selection

_{Go to top - main - nodes - nodes menus}

handle_type_selection_vector#

def handle_type_selection_vector(self, left=True, right=True)

Node: Handle Type Selection | Blender reference | api reference

Args:#

handle_type (str): ‘AUTO’ in [FREE, AUTO, VECTOR, ALIGN]
mode (set): {‘RIGHT’, ‘LEFT’}

Returns:#

node with sockets [‘selection’]

_{Go to top - main - nodes - nodes menus}

index_for_sample#

def index_for_sample(self, default=None)

Return default if not None or Input index socket.

The node ‘Sample Index’ has an input with default value to 0. If mehod argument is None, create a node ‘Input Index’ as input.

sample_index method is implemented:

def sample_index(self, value=None, index=None, clamp=False):
    return nodes.SampleIndex(..., index=self.index_for_sample(index), ...)

Returns:#

default or Input index

_{Go to top - main - nodes - nodes menus}

instance_on_points#

def instance_on_points(self, instance=None, pick_instance=None, instance_index=None, rotation=None, scale=None)

Node: Instance on Points | Blender reference | api reference

Args:#

instance: Geometry
pick_instance: Boolean
instance_index: Integer
rotation: Vector
scale: Vector

Returns:#

socket instances of class Instances

_{Go to top - main - nodes - nodes menus}

interpolate#

def interpolate(self, value=None)

Node: Interpolate Domain | Blender reference | api reference

Args:#

value: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘Boolean’]

Returns:#

socket value

_{Go to top - main - nodes - nodes menus}

material_selection#

def material_selection(self, material=None)

Node: Material Selection | Blender reference | api reference

Args:#

material: Material

Returns:#

socket selection

_{Go to top - main - nodes - nodes menus}

named_attribute#

def named_attribute(self, name=None, data_type='FLOAT')

Node: Named Attribute | Blender reference | api reference

Args:#

name: String
data_type (str): ‘FLOAT’ in [FLOAT, INT, FLOAT_VECTOR, FLOAT_COLOR, BOOLEAN]

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

named_boolean#

def named_boolean(self, name=None)

Node: Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

named_color#

def named_color(self, name=None)

Node: Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

named_float#

def named_float(self, name=None)

Node: Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

named_integer#

def named_integer(self, name=None)

Node: Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

named_vector#

def named_vector(self, name=None)

Node: Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

offset#

def offset(self, offset=None)

Node: Offset Point in Curve | Blender reference | api reference

Args:#

offset: Integer

Node Image

Returns:#

tuple (’is_valid_offset’, ‘point_index’)

_{Go to top - main - nodes - nodes menus}

proximity#

def proximity(self, target=None, source_position=None)

Node: Geometry Proximity | Blender reference | api reference

Args:#

target: Geometry
source_position: Vector

Returns:#

socket distance

_{Go to top - main - nodes - nodes menus}

remove_named_attribute#

def remove_named_attribute(self, name=None)

Node: Remove Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

self

_{Go to top - main - nodes - nodes menus}

sample_index#

def sample_index(self, value=None, index=None, clamp=False)

Node: Sample Index | Blender reference | api reference

Args:#

value: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘Boolean’]
index: Integer
clamp (bool): False

Returns:#

socket value

_{Go to top - main - nodes - nodes menus}

select#

def select(self, selection)

Select the domain

If the method is called on a Domain which already has a selection, the two selections are combined:

verts = mesh.verts[10:20] # Selection of vertices from 10 to 20
v = verts.select((verts.index % 2).equal(0)) # Even indices in the previous selection

Args:#

selection (Boolean or Integer): The selection condition

Returns:#

Domain with the given selection (Domain)

If a selection is existing, the resulting selection is a logical and betwenn the two

_{Go to top - main - nodes - nodes menus}

separate#

def separate(self)

Node: Separate Geometry | Blender reference | api reference

Node Image

Returns:#

tuple (’selection’, ‘inverted’)

_{Go to top - main - nodes - nodes menus}

set_ID#

def set_ID(self, ID=None)

Node: Set ID | Blender reference | api reference

Args:#

ID: Integer

Returns:#

self

_{Go to top - main - nodes - nodes menus}

set_handle_positions#

def set_handle_positions(self, position=None, offset=None, mode='LEFT')

Node: Set Handle Positions | Blender reference | api reference

Args:#

position: Vector
offset: Vector
mode (str): ‘LEFT’ in [LEFT, RIGHT]

Returns:#

self

_{Go to top - main - nodes - nodes menus}

set_handle_positions_left#

def set_handle_positions_left(self, position=None, offset=None)

Node: Set Handle Positions | Blender reference | api reference

Args:#

position: Vector
offset: Vector

Returns:#

self

_{Go to top - main - nodes - nodes menus}

set_handle_positions_right#

def set_handle_positions_right(self, position=None, offset=None)

Node: Set Handle Positions | Blender reference | api reference

Args:#

position: Vector
offset: Vector

Returns:#

self

_{Go to top - main - nodes - nodes menus}

set_handle_type#

def set_handle_type(self, left=True, right=True, handle_type='AUTO')

Node: Set Handle Type | Blender reference | api reference

Args:#

curve: Curve
selection: Boolean
handle_type (str): ‘AUTO’ in [FREE, AUTO, VECTOR, ALIGN]
mode (set): {‘RIGHT’, ‘LEFT’}

Returns:#

node with sockets [‘curve’]

_{Go to top - main - nodes - nodes menus}

set_handle_type_node#

def set_handle_type_node(self, handle_type='AUTO', mode={'RIGHT', 'LEFT'})

Node: Set Handle Type | Blender reference | api reference

Args:#

handle_type (str): ‘AUTO’ in [FREE, AUTO, VECTOR, ALIGN]
mode (set): {‘RIGHT’, ‘LEFT’}

Returns:#

self

_{Go to top - main - nodes - nodes menus}

set_position#

def set_position(self, position=None, offset=None)

Node: Set Position | Blender reference | api reference

Args:#

position: Vector
offset: Vector

Returns:#

self

_{Go to top - main - nodes - nodes menus}

set_radius#

def set_radius(self, radius=None)

Node: Set Curve Radius | Blender reference | api reference

Args:#

radius: Float

Returns:#

self

_{Go to top - main - nodes - nodes menus}

set_tilt#

def set_tilt(self, tilt=None)

Node: Set Curve Tilt | Blender reference | api reference

Args:#

tilt: Float

Returns:#

self

_{Go to top - main - nodes - nodes menus}

socket_stack#

def socket_stack(self, node, socket_name=None)

Make the owning socket jump to the output socket of the node passed in argumment.

Args:#

node (Node): The node to jump to
socket_name: The name of the output socket (first one if None)

_{Go to top - main - nodes - nodes menus}

store_named_attribute#

def store_named_attribute(self, name=None, value=None, data_type=None)

Store a named attribute

If selection exists, create an intermediary cloud of points to update selectively the items.

Args:#

name (str): name of the attribute
value (any): value of the attribute
data_type (str): valeu data type

Returns:#

data socket (DataSocket)

_{Go to top - main - nodes - nodes menus}

store_named_attribute_no_selection#

def store_named_attribute_no_selection(self, name=None, value=None)

Node: Store Named Attribute | Blender reference | api reference

Args:#

name: String
value: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

Returns:#

self

_{Go to top - main - nodes - nodes menus}

store_named_boolean#

def store_named_boolean(self, name, value)

Store a named attribute of type Boolean

see store_named_attribute

Args:#

name (str): the attribute name
value (float): the value to store

Returns:#

Data socket (DataSocket)

_{Go to top - main - nodes - nodes menus}

store_named_color#

def store_named_color(self, name, value)

Store a named attribute of type Color

Args:#

name (str): the attribute name
value (float): the value to store

see store_named_attribute

Returns:#

Data socket (DataSocket)

_{Go to top - main - nodes - nodes menus}

store_named_float#

def store_named_float(self, name, value)

Store a named attribute of type Float

see store_named_attribute

Args:#

name (str): the attribute name
value (float): the value to store

Returns:#

Data socket (DataSocket)

_{Go to top - main - nodes - nodes menus}

store_named_integer#

def store_named_integer(self, name, value)

Store a named attribute of type Integer

see store_named_attribute

Args:#

name (str): the attribute name
value (float): the value to store

Returns:#

Data socket (DataSocket)

_{Go to top - main - nodes - nodes menus}

store_named_vector#

def store_named_vector(self, name, value)

Store a named attribute of type Vector

Args:#

name (str): the attribute name
value (float): the value to store

see store_named_attribute

Returns:#

Data socket (DataSocket)

_{Go to top - main - nodes - nodes menus}

view#

def view(self, value=None)

Node: Viewer | Blender reference | api reference

Args:#

value: [‘Float’, ‘Vector’, ‘Color’, ‘Integer’, ‘Boolean’]

Returns:#

node with sockets []

_{Go to top - main - nodes - nodes menus}

viewer#

def viewer(self, value=None)

Node: Viewer | Blender reference | api reference

Args:#

value: [‘Float’, ‘Vector’, ‘Color’, ‘Integer’, ‘Boolean’]

Returns:#

node with sockets []

_{Go to top - main - nodes - nodes menus}