Class: Sketchup::InputPoint

Inherits:
Object
  • Object
show all
Defined in:
lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb

Overview

The InputPoint class is used to pick 3d points and/or entities that reside under the current cursor location, similar to native Line tool and other drawing tools. Unlike PickHelper, InputPoint uses inference, i.e. “snaps” to vertices and other entities when the cursor is close to them.

Only Tools react to cursor location and most of these methods are only useful in the context of a tool. For example, if you want to determine the 3d point you just moved the cursor over, you would use #pick from within your Tool#onMouseMove method. InputPoints are best picked from mouse move, as you want them to draw them to the view.

For an example, see github.com/SketchUp/sketchup-ruby-api-tutorials/tree/master/examples/02_custom_tool.

To lock inference similar to native SketchUp tools, see View#lock_inference.

Version:

  • SketchUp 6.0

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Sketchup::InputPoint #initialize(pt_or_vertex) ⇒ Sketchup::InputPoint

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)

Overloads:

Version:

  • SketchUp 6.0



243
244
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 243

def initialize(*args)
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

Parameters:

  • inputpoint2 —

    The second input point in the comparison.

Returns:

  • status - true if the InputPoint objects are the same object. False if the objects are not the same.

Version:

  • SketchUp 6.0



47
48
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 47

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

Returns:

  • inputpoint - the cleared (empty) input point if this successful

Version:

  • SketchUp 6.0



67
68
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 67

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

Parameters:

  • inputpoint —

    The second input point.

Returns:

  • inputpoint - the new input point that received the copy if successful

Version:

  • SketchUp 6.0



89
90
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 89

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

Returns:

  • degrees_of_freedom - see comments.

Version:

  • SketchUp 6.0



118
119
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 118

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

Returns:

  • depth - a number representing the depth of the inputpoint (inside groups and components) if successful

Version:

  • SketchUp 6.0



139
140
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 139

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

Returns:

  • (Boolean) —

    status - true if the draw method will draw something, false if the draw method has nothing to draw

Version:

  • SketchUp 6.0



158
159
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 158

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

Parameters:

  • view —

    The current view.

Returns:

  • view

Version:

  • SketchUp 6.0



180
181
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 180

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

Returns:

  • edge - an Edge object if successful, or nil if unsuccessful

Version:

  • SketchUp 6.0



197
198
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 197

def edge
end

#face ⇒ Sketchup::Face?

Note:

The InputPoint doesn’t necessarily lie on the face, but can be e.g. on an edge in front of the face.

The face method retrieves the face at or behind the input point. This can be used to determine a plane, similar to what native Rotate tool does.

Examples:

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

Returns:

Version:

  • SketchUp 6.0



216
217
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 216

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

Returns:

Version:

  • SketchUp 2017



264
265
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 264

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

Parameters:

  • view —

    The current view.

  • x —

    A x value.

  • y —

    A y value.

  • inputpoint (optional) —

    A second input point used as a reference for the pick.

Returns:

  • status - true if a valid InputPoint was picked and it is different than it was before.

Version:

  • SketchUp 6.0



304
305
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 304

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

Returns:

  • point - a Point3d object position for the input point if successful

Version:

  • SketchUp 6.0



320
321
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 320

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

Returns:

  • tip - a string tooltip or an empty string (if the input point doesn’t provide a tooltip).

Version:

  • SketchUp 6.0



338
339
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 338

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

Returns:

  • transformation - the Transformation for the input point if successful

Version:

  • SketchUp 6.0



366
367
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 366

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?

Returns:

  • (Boolean) —

    status - true if the input point has valid data, false if it does not have valid data.

Version:

  • SketchUp 6.0



384
385
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 384

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

Returns:

  • vertex - The associated vertex

Version:

  • SketchUp 6.0



402
403
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb', line 402

def vertex
end