Drawingelement

class

• Introduction
• Methods
• • bounds
  • casts_shadows=
  • casts_shadows?
  • erase!
  • hidden=
  • hidden?
  • layer
  • layer=
  • material
  • material=
  • receives_shadows=
  • receives_shadows?
  • visible=
  • visible?

Introduction

Methods

Drawingelement.boundsSketchUp 6.0+

The bounds method is used to retrieve the BoundingBox for an drawing element.

Returns:

boundingbox

A BoundingBox object if successful

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts
 # Remember, anything that can be displayed, such as a face, is also
 # a Drawingelement. So I can call bounds on a face because Face
 # is a sub-class of Drawingelement.
 boundingbox = face.bounds

Drawingelement.casts_shadows=SketchUp 6.0+

The casts_shadows= method is used to set the Drawingelement to cast shadows.

Arguments:

casts

true if you want the Drawingelement object to cast shadows, false if you do not want the Drawingelement object to cast shadows.

Returns:

status

true if successful, false if unsuccessful.

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 100]
 pts[1] = [width, 0, 100]
 pts[2] = [width, depth, 100]
 pts[3] = [0, depth, 100]
 # Add the face to the entities in the model.
 face = entities.add_face pts  

 # Make the face not cast shadows.
 status = face.casts_shadows = false
 UI.messagebox status.to_s

Drawingelement.casts_shadows?SketchUp 6.0+

The casts_shadows? method is used to determine if the Drawingelement is casting shadows.

Returns:

status

true if the Drawingelement is casting shadows, false if unsuccessful.

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts  
 status = face.casts_shadows?
 UI.messagebox status.to_s

Drawingelement.erase!SketchUp 6.0+

The erase! method is used to erase an element from the model.

Erasing an Edge also erases all of the Face objects that use the Edge.

Returns:

status

true if successful, false if unsuccessful

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts
 status = face.erase!

Drawingelement.hidden=SketchUp 6.0+

The hidden= method is used to set the hidden status for an element.

Arguments:

hidden

true if you want to hide the element, false if you do not want to hide the element.

Returns:

status

true if the element has been hidden, false if the element has not been hidden.

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts
 UI.messagebox "Click OK to Hide the Box"        
 status = face.hidden = true

Drawingelement.hidden?SketchUp 6.0+

The hidden? method is used to determine if the element is hidden.

Hidden elements are still in the model, but they are not displayed.

Returns:

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts        
 status = face.hidden?
 UI.messagebox "hidden? " + status.to_s

Drawingelement.layerSketchUp 6.0+

The layer method is used to retrieve the Layer object of the drawing element.

Returns:

layer

a layer object if successful

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts  
 layer = face.layer

Drawingelement.layer=SketchUp 6.0+

The layer= method is used to set the layer for the drawing element.

An exception is raised if you give a string that doesn't match any layer name.

Arguments:

layer

A layer number.

layername

A layer name.

Returns:

layer

the new Layer object if successful

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts  
 # Add a layer
 layer = Sketchup.active_model.layers.add "joe"
 # Put the face on the joe layer (instead of layer 0)
 newlayer = face.layer = layer

Drawingelement.materialSketchUp 6.0+

The material method is used to retrieve the material for the drawing element.

Returns:

material

the Material object if successful

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts  
 material = face.material

Drawingelement.material=SketchUp 6.0+

The material= method is used to set the material for the drawing element.

Arguments:

material

A Material, name of a material, Color, or name of a color.

Returns:

material

the new Material object if successful

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts  
 m = model.materials.add "Joe"
 begin
   # Returns nil if not successful, path if successful.
   # Should return a texture object.
   m.texture = "c:\\My Textures\\Carpet.jpg"
 rescue
   UI.messagebox $!.message
 end
 # You will see the material applied when you reverse the box's faces
 material = face.material = m

Drawingelement.receives_shadows=SketchUp 6.0+

The receive_shadows= method is used to set the Drawingelement to receive shadows.

Arguments:

receive

true if you want the Drawingelement object to receive shadows, false if not.

Returns:

status

true if successful, false if unsuccessful.

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 100]
 pts[1] = [width, 0, 100]
 pts[2] = [width, depth, 100]
 pts[3] = [0, depth, 100]
 # Add the face to the entities in the model.
 face = entities.add_face pts  

 # Make the face not receive shadows.
 status = face.receives_shadows = false
 UI.messagebox status.to_s

Drawingelement.receives_shadows?SketchUp 6.0+

The receive_shadows? method is used to determine if the Drawingelement is receiving shadows.

Returns:

status

true if the Drawingelement is receiving shadows, false if unsuccessful.

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts  
 status = face.receives_shadows?
 UI.messagebox status.to_s

Drawingelement.visible=SketchUp 6.0+

The visible= method is used to set the visible status for an element. This method performs an opposite function to the hidden= method.

Arguments:

visibility

true if you want to hide the element, false if not

Returns:

status

true if the element has been hidden, false if the element has not been hidden.

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts  
 UI.messagebox "Click OK to Hide the Box"        
 status = face.visible = false

Drawingelement.visible?SketchUp 6.0+

The visible? method is used to get the visible status for an element.

Returns:

visibility

true if visible, false if not

 depth = 100
 width = 100
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts  
 UI.messagebox "Click OK to Hide the Box"        
 face.visible = false
 UI.messagebox "Is the face visible? " + face.visible?.to_s