SketchUp RUBY API Wishlist [way of coding wishes, please]

[thomthom]

Being able to set Layer colour.

[thomthom]

* Being able to set Material name.
* Being able to delete materials.
* Being able to delete ComponentDefinitions

[TIG]

You can delete a definition's instances and then that individual definition from the component-browser thus:

Code: Select all

model.start_operation("Delete Instances and Definition")
  definition.instances.each{|instance|instance.erase! if instance.valid?}
  # this 1st step is optional since all instance become nil anyway when the definition is emptied
  definition.entities.erase_entities(definition.entities.to_a)
model.commit_operation

Assumes you have set model and definition... It empties a definition and therefore it disappears off the browser listing. It must be inside an operation to work.


PS: You can delete a material BUT it's pretty convoluted. I'll publish a script for it shortly...

[thomthom]

I've not had 100% success with deleting definitions like that. I seemed to run into bugsplats. But I'll do new tests.



As for materials, I seen how V-Ray for Sketchup renames and deletes materials:
Deleting: iterate the whole model and remove the material - then apply unused materials to dummy groups and purge.

Rename: Create new material identical to old with new name - iterate and replace the old material with new. Then run the Delete method.

Ugly hacks which I'd rather not use. When model grows in size this just bogs down.

[TIG]

viewtopic.php?p=166978#p166978 has material.delete method - I've streamlined it as much as possible ???

[TIG]

I've also made the equivalent layer.delete method here viewtopic.php?p=166985#p166985 ...

[TIG]

I've also made a material.name="new_name" method here viewtopic.php?p=167219#p167219 ...

[TIG]

material.name="new_name" method now v1.1 - here viewtopic.php?p=167219#p167219
Temp folder fixed for Mac users...

[narongwit12]

Be able to track the shadow area on each face. This could make the calculation of shading possible for energy simulation.

[•BTM]

• to have the 5th (optional) argument for write_image as 'Transparent Background' if the file type is .png

[Dan Rathbun]

Sketchup::load

The Sketchup::load method does NOT expose the wrap argument, so we can specify wrap=true for rbs scripts.

For some unknown reason, the Google team defeated, or just didn't pass the 2nd argument (wrap) on to the aliased standard load, when they overrode it to handle rbs decrypting.

Please fix this!
_

[Pout]

Here is my list:

* Tig, although your solutions on material.name=, layer.delete, material.delete are good, it seems to me it would be much easier to just have them in the API. So i second the proposals of ThomThom

* Also i second the proposal of Morisdov concerning the add_framechange_observer not firing when creating movies or when working in layout. It should fire there to.

* make the entity.id consistent throughout different SU sessions (it changes now from time to time)
* it would be great if you could just select an entity based on a parameter (eg. entity.id) without looping all the entities in the model
* being able to access the font/size and other parameters of a text
* make a difference between the execution of scripts and the interface so it is possible to incorporate a 'stop script' button for example. Now the interface freezes as long as scripts are running. This makes users believe the execution of the script has halted and Sketchup has stopped working.
* ...more to come

[thomthom]

* Tig, although your solutions on material.name=, layer.delete, material.delete are good, it seems to me it would be much easier to just have them in the API.

And it would be faster.

* make the entity.id consistent throughout different SU sessions (it changes now from time to time)

Ditto!

* it would be great if you could just select an entity based on a parameter (eg. entity.id) without looping all the entities in the model

Ditto. If you have a script that requires observers attached to some objects one want these to be reattached when the model is loaded. Currently one has to iterate the whole model to find the entities, and one has to attach an attribute to be able to find the correct one - which means string comparisons which are really slow.
So a better way to directly reference entities across sessions would be a great addition.

* make a difference between the execution of scripts and the interface so it is possible to incorporate a 'stop script' button for example. Now the interface freezes as long as scripts are running. This makes users believe the execution of the script has halted and Sketchup has stopped working.

while true
puts 'Ditto!'
end

[Dan Rathbun]

Being able to set Layer colour.

..and also a "getter" method to read the color.

Actually when you manually click the color button in the Layers dialog, the Edit Material dialog appears. If you choose 'Use texture image' and assign a texture file, the layer will be displayed with that texture over the layer color, when 'Color by Layer' is true, and rendering mode is 'Shaded with Textues'.

Issues:
(1) Technically, Layers have a material attribute that holds a Sketchup::Material object.
(2) These material objects ARE saved with the model, but NOT accessible thru the API.
(3) When a layer is assigned a texture, it does not appear in the "In Model" Materials Collection, and it should as well as allow us to assign a name (thru the layer's material object.)
In the UI manual mode the new material could be given a temporary name equal to the Layer name, so the user could manually rename it thru the Materials Browser, or we could name it in a subsequent ruby statment like:
model.materials['Layer3'].name='PolishedWood'
We should also then be able to go totally automatic thru the API, thus:
mat = model.materials.add('PolishedWood')
mat.texture = 'wood/polished.png'
mat.color = [195,144,86]
model.layers['Layer3'].name = 'Surface'
model.layers['Surface'].material = 'PolishedWood'
model.rendering_options['DisplayColorByLayer'] = true
Later on getting a layer's color, we could do:
surfaceColor = model.layers['Surface'].material.color
and setting it to some other color:
surfaceColor = [127,127,200]
model.layers['Surface'].material.color = surfaceColor [*]

** So what we really need is the Sketchup::Layer object's material attribute getter and setter methods exposed in the API, along with the manual UI naming hack.

---

EDIT: [*] (2010AUG05) Added missing "wish" statement to set layer color.

[Pout]

does anyone know if any of the remarks here will be taken into consideration in a new version?

[Dan Rathbun]

Sketchup::load

The Sketchup::load method does NOT expose the wrap argument, so we can specify wrap=true for rbs scripts.

For some unknown reason, the Google team defeated, or just didn't pass the 2nd argument (wrap) on to the aliased standard load, when they overrode it to handle rbs decrypting.

Please fix this!_

Taking this a step further.

Since the rbs code blocks are eval'd, and Sketchup.load is an override (redefinition,) just pass the 2nd argument to Sketchup.load (if given,) on as the 2nd argument to the eval method.

That way developers can instantiate a binding() to their custom namespace(s), and have the code evaluated within that scope.

This can also give the GSUT the opportunity to protect some Google namespaces, within the argument validation block of the Sketchup.load method (ie: raise a custom "NotAllowedError" exception.)

[Dan Rathbun]

---

EDITED: Get||Set Layer Material & Color

---

Added missing "wish" statement to set Layer color in the example I gave (the last statement.)

---

[kwalkerman]

Seconded on the Layers usability, also, it would be great to be able to do:

Layers.active_layer
Layers[layer] = active

A consistent entityID would be awesome. The entity should maintain the ID if it is deleted, and then undeleted as well.

Pages:

In addition to retaining information on which layers are on and off, should also be able to retain the active layer for each page.

--
Karen

[Dan Rathbun]

Seconded on the Layers usability, also, it would be great to be able to do:

Layers.active_layer

That can already be done:
Sketchup.active_model.active_layer
.. as it's a property of the model (Sketchup::Model class.)

see API: Model.active_layer

Layers[layer] = active

Will not work because there is no .= method defined for the Sketchup::Layer class. (You'd just be calling Ruby's internal hardcoded refererence assignment operator, which could set the layer reference on the left of the operator, to any kind of Ruby object. A bad idea, if it doesn't immediately cause an exception.)
This why the .new constructor is "hidden" (or made private,) and we create layers thru the collection class' .add method.

Sketchup.active_model.active_layer=layers['mylayername']
.. again, a property of the model (Sketchup::Model class.)

see API: Model.active_layer=

---

You CAN get a SKP DOM object's parent by using the .parent method. The model is the layer collection's parent, in the SKP doucment heirarchy. Where layers is the model's Sketchup::Layers class instance:
this_layer = layers.parent.active_layer

But, since each model instance, has an instance of a Sketchup::Layers class object, you'd think it (the Layers collection,) should also know which one of it's elements was active.
A simple Ruby patch for the Layers class:

Code: Select all

class Sketchup::Layers
  unless method_defined?('active')
    def active
      self.parent.active_layer
    end # def active
  end
  unless method_defined?('current')
    alias_method('current','active')
  end
  unless method_defined?('active=')
    def active=(arg)
      if arg.class==String || arg.kind_of?Integer
        self.parent.active_layer=self[arg]
      elsif arg.class==Sketchup::Layer
        self.parent.active_layer=arg
      else
        raise(TypeError,'Sketchup::Layer, String, or Integer expected.')
      end
    end # def active=
  end
  unless method_defined?('current=')
    alias_method('current=','active=')
  end
end # class extension


EDIT:

• added aliases
• fixed method defintion tests

Note: The reason I do not call Sketchup.active_model.active_layer (in the patch,) is to accomodate multi-model environment on the Mac, where the active model may not be the one a script is working on.

---

ADD: This can be extended to the Sketchup::Layer class, so that a layer can return (boolean) whether it is the active layer or not.

Code: Select all

class Sketchup::Layer
  unless method_defined?('active?')
    def active?
      # .equal? returns true ONLY if receiver and arg have same object_id
      self.equal?( self.parent.parent.active_layer )
    end # def active?
  end
  unless method_defined?('current?')
    alias_method('current?','active?')
  end
  #
  unless public_methods(false).include?('eql?')
    # only override if it hasn't yet been redefined
    def eql?(arg)
      if arg.class==Sketchup::Layer
        # we shall ignore the name attribute
        # use the == override to include name in test
        # use <=> to test only the names (match returns 0)
        same = true
        return (same = (self.page_behavior==arg.page_behavior)) if (not same)
        return (same = (self.visible?==arg.visible?)) if (not same)
        return same
      else
        raise(TypeError,'Sketchup::Layer expected.')
      end
    end # override eql?
  end
  #
end # class extension


[thomthom]

hm... never thought of that inconsistency before...
model.materials.current vs model.active_layer

[Dan Rathbun]

hm... never thought of that inconsistency before...
model.materials.current vs model.active_layer

"current and "active" should aliases for each other.

[kwalkerman]

Cool. Thanks again.

[Dan Rathbun]

Cool. Thanks again.

No problem.

(bumping the topic..)

• Made edits to the Layers code example
• Added a second code example for Layer class.

See previous post...

[Jim]

In addition to retaining information on which layers are on and off, should also be able to retain the active layer for each page.

I like this idea, particularly useful when adding text to Scenes. It seems quite possible using an Observer.

[Jim]

hm... never thought of that inconsistency before...
model.materials.current vs model.active_layer

"current and "active" should aliases for each other.

Well, don't leave out Pages.selected_page!

[Dan Rathbun]

hm... never thought of that inconsistency before...
model.materials.current vs model.active_layer

"current and "active" should aliases for each other.

Well, don't leave out Pages.selected_page!

I don't know about that one... Pages are special. Even though you "select" a Page, depending on transition time, Sketchup can be animating somewhere between the previous page and the selected one.
A FrameChangeObserver is needed to know when the animation is complete. Only at that point would I 'technically' say that a Page was the "active_page" or "current_page."

@Karen. You can get an array of the hidden layers for a Page:
mypage.layers
so the visible layers would be:
my_vis_layers = model.layers.to_a - mypage.layers
* why they didn't name the method Page.hidden_layers, I don't know.

[Dan Rathbun]

..., should also be able to retain the active layer for each page.

I like this idea, particularly useful when adding text to Scenes. It seems quite possible using an Observer.

But when you add text to Scenes (Pages,) are you drawing to the model, or drawing to the View ??

If it's the View, then the active layer does not matter.

The active layer is a property of the model. A Scene (Page,) is a View mechanism, which does not "have" layers; it only 'remembers' which of the model's layers to hide or show. A layer also has "new page behaviour" which it can tell new Scenes (Pages,) how to 'remember' their visibilty.

I can see some problems for other scripts, if the active layer was automatically changed when a Scene changed. There would need to be some kind of toggle to turn the "auto" feature on and off.
In addition, their would need to be scoping. What if an Observer was to be triggered while this "auto layer" feature was on? Outside the current script (or scope,) the Observer may want to "see" or "use" another layer as the active one.

It also occurs to me, that we are supposed to always be drawing primitives on "Layer 0", but still some modelers want to draw on other layers (construction lines especially.)

Anyway.. we'd need to consider this carefully. It could be a disaster.