Class: Sketchup::InputPoint

Inherits:
Object
  • Object
show all
Defined in:
SketchUp/Sketchup/InputPoint.rb

Overview

The InputPoint used to pick entities that reside under the current cursor location. InputPoint and PickHelper are similar, but InputPoint also uses inferencing. Only tools react to cursor location. Therefore, most of the methods in this class are only useful in the context of a tool you are writing. For example, if you want to determine the entity that you just clicked on with the mouse, you would use InputPoint.pick from within your onLMouseButton method in a tool. See the example script linetool.rb for examples of using the InputPoint class.

Version:

  • SketchUp 6.0

Instance Method Summary collapse

Constructor Details

#initialize(pt_or_vertex) ⇒ Object

Note:

Prior to SketchUp 2019 it was not possible to sub-class Sketchup::InputPoint due to a bug in how SketchUp initialized the class.

The new method is used to create a new InputPoint object.

Examples:

ip1 = Sketchup::InputPoint.new

# Or you can construct it at an arbitrary location.
starting_point = Geom::Point3d.new(100, 200, 300)
ip2 = Sketchup::InputPoint.new(starting_point)

Version:

  • SketchUp 6.0



233
234
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 233

def initialize(pt_or_vertex)
end

Instance Method Details

#==(inputpoint2) ⇒ Object

The == method is used to determine if two input points are the same.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = Sketchup::InputPoint.new
ip2 = view.inputpoint x,y
# Copy the contents of inputpoint2 into inputpoint1
ip1.copy! ip2
# Returns true
status = ip1 == ip2

Version:

  • SketchUp 6.0



38
39
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 38

def ==(inputpoint2)
end

#clear ⇒ Object

The clear method is used to clear the input point.

This sets it to an empty state. After calling this, valid? will return false.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
# Returns true
ip = ip1.clear

Version:

  • SketchUp 6.0



58
59
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 58

def clear
end

#copy!(inputpoint) ⇒ Object

The copy! method is used to copy the data from a second input point into this input point.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = Sketchup::InputPoint.new
ip2 = view.inputpoint x,y
# Copy the contents of inputpoint2 into inputpoint1
ip = ip1.copy! ip2

Version:

  • SketchUp 6.0



80
81
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 80

def copy!(inputpoint)
end

#degrees_of_freedom ⇒ Object

The degrees_of_freedom method retrieves the number of degrees of freedom there are for an input point.

If you are just getting a point in space, then the degrees_of_freedom will be 3 - meaning that there is nothing about the point that would constrain its position.

If you are on a face, then the degrees_of_freedom will be 2 meaning that you can only move on the plane of the face.

If you are on an Edge or an axis, then the degrees_of_freedom will be 1 meaning that you can only move in the direction of the edge or axis.

If you get an end point of an Edge, or an intersection point, then the degrees_of_freedom will be 0.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
dof = ip1.degrees_of_freedom

Version:

  • SketchUp 6.0



109
110
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 109

def degrees_of_freedom
end

#depth ⇒ Object

The depth method retrieves the depth of an inference if it is coming from a component.

If the InputPoint is not getting a position from inside a component, this method will return 0. Otherwise it returns the depth of the entity in a nested component that is providing the position.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
d = ip1.depth

Version:

  • SketchUp 6.0



130
131
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 130

def depth
end

#display? ⇒ Boolean

The display? method is used to determine if the input point has anything to draw.

If the method returns true, then the draw method will draw something.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
status = ip1.display

Version:

  • SketchUp 6.0



151
152
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 151

def display?
end

#draw(view) ⇒ Object

The draw method is used to draw the input point.

This is useful for showing an InputPoint from within the draw method of a tool that you have implemented in Ruby. Additional examples are available in the Plugins/examples directory.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
ip = ip1.draw view

Version:

  • SketchUp 6.0



173
174
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 173

def draw(view)
end

#edge ⇒ Object

The edge method is used to retrieve the edge if the input point is getting its position from a point on an Edge.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
e = ip1.edge

Version:

  • SketchUp 6.0



190
191
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 190

def edge
end

#face ⇒ Object

The face method retrieves the face if the input point is getting its position from a face.

Otherwise it returns nil.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
f = ip1.face

Version:

  • SketchUp 6.0



209
210
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 209

def face
end

#instance_path ⇒ Sketchup::InstancePath?

The #instance_path method retrieves the instance path for the picked point.

The returned instance_path is a copy of what the input point is holding on to at the moment you access it. Your copy will not update if you make new picks with the input point.

If there has been no valid pick it will return ‘nil`.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip = view.inputpoint(x, y)
instance_path = ip.instance_path

Version:

  • SketchUp 2017



254
255
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 254

def instance_path
end

#pick(view, x, y, inputpoint) ⇒ Object

The pick method is used to get the input point at a specific screen position.

The first form just uses the screen position to compute the InputPoint. It is used when you don’t want the InputPoint to be dependent on another InputPoint.

The second form uses the screen position and another InputPoint. It will find additional inferences such as along one of the axis directions from the first point.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
inputpoint = view.inputpoint x, y
inputpoint2 = Sketchup::InputPoint.new
inputpoint.pick view, x, y
inputpoint.pick view, x, y, inputpoint2

Version:

  • SketchUp 6.0



294
295
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 294

def pick(view, x, y, inputpoint)
end

#position ⇒ Object

The position method is used to get the 3D point from the input point.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
point = ip1.position

Version:

  • SketchUp 6.0



310
311
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 310

def position
end

#tooltip ⇒ Object

The tooltip method is used to retrieve the string that is the tool tip to display for the input point.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
# Click on a face and you get "On Face"
tip = ip1.tooltip

Version:

  • SketchUp 6.0



328
329
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 328

def tooltip
end

#transformation ⇒ Object

The transformation method retrieves the Transformation object for the input point.

If the InputPoint object is getting its position from something inside of a component instance, this method returns the Transformation of the component instance. Otherwise it returns the identity Transformation.

Note that the position method on a input point always returns a point that is transformed into model space. If you are using the edge, face or vertex method on the InputPoint though, you will probably need to use the transformation method to transform the data that you get back from the selected entity.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
# In this case, returning the identity transformation
tform = ip1.transformation

Version:

  • SketchUp 6.0



356
357
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 356

def transformation
end

#valid? ⇒ Boolean

The valid? method is used to determine if an input point has valid data.

You must have called the pick method to set the data before it is valid.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
status = ip1.valid?

Version:

  • SketchUp 6.0



376
377
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 376

def valid?
end

#vertex ⇒ Object

The vertex method returns a Vertex associated with the InputPoint. If the InputPoint is on the end of a line, then it will return the Vertex. If the InputPoint does not select any vertices this method returns nil.

Examples:

view = Sketchup.active_model.active_view
x = 100
y = 100
ip1 = view.inputpoint x,y
# Click on a face and you get "On Face"
tip = ip1.vertex

Version:

  • SketchUp 6.0



394
395
 
# File 'SketchUp/Sketchup/InputPoint.rb', line 394

def vertex
end