Class: Sketchup::TextureWriter

Inherits:
Object
  • Object
show all

Overview

The TextureWriter class is used primarily for writing the textures used in a SketchUp model out to files as part of an export for use in another application. These methods are usually invoked in this order:

- 1. load - load one or more textures from a model into the TextureWriter.
- 2. write_all or write - write the texture(s) to file.

Examples:

# This code snippet sets up a texture writer and some variables that are
# used in the following texture writer examples.
# Assumptions:
# 1) The active model contains at least one entity at the root level of the
#    following types: component instance, group, or image.
# 2) The active model contains at least one face at the root level.
model = Sketchup.active_model
entities = model.entities
faces = entities.grep(Sketchup::Face)
texturable_entities = entities.select{ |ent|
    (ent.is_a?(Sketchup::ComponentInstance) ||
     ent.is_a?(Sketchup::Group) || ent.is_a?(Sketchup::Image)) }
tw = Sketchup.create_texture_writer

Version:

  • SketchUp 6.0

Instance Method Summary # collapse

Instance Method Details

↑ #count ⇒ Integer

The #length method is used to determine the number of textures loaded into the texture writer.

The #count method is an alias for #length.

Examples:

length = tw.length
tw.load(texturable_entities[0])
if length < tw.length
  puts("A new entity was successfully loaded into the writer.")
end

Returns:

  • (Integer) —

    length - the number of textures loaded in the texture writer

Version:

  • SketchUp 6.0

↑ #filename(handle) ⇒ String

The filename method is used to retrieve the original filename for a particular texture.

Examples:

index = tw.load(texturable_entities[0])
filename = tw.filename(index)
puts("filename = #{filename}")

Returns filename - the filename of the texture on the file system. Textures can be generated without filenames, so if the texture doesn't have a name write_all will save the texture to an image file named “i.png”. Where i is the first integer greater than zero which was not already used for a png file name.

Parameters:

  • handle (Integer) —

    The index or handle of the texture in the texture writer.

Returns:

  • (String) —

    filename - the filename of the texture on the file system. Textures can be generated without filenames, so if the texture doesn't have a name write_all will save the texture to an image file named “i.png”. Where i is the first integer greater than zero which was not already used for a png file name.

Version:

  • SketchUp 6.0

↑ #handle(entity) ⇒ Integer #handle(face, side) ⇒ Integer

The handle method is used to retrieve a handle or index for a specific texture in the texture writer.

Examples:

tw.load(texturable_entities[0])
handle = tw.handle(texturable_entities[0])
load_front_face = true
tw.load(faces[0], load_front_face)
handle = tw.handle(faces[0], load_front_face)

Overloads:

  • #handle(entity) ⇒ Integer

    Returns the index for the entity in the texture writer.

    Parameters:

    Returns:

    • (Integer) —

      the index for the entity in the texture writer.

  • #handle(face, side) ⇒ Integer

    Returns the index for the entity in the texture writer.

    Parameters:

    • face (Sketchup::Face)
    • side (Boolean) —

      Specifies one of the sides of the face (true if front, false if back.)

    Returns:

    • (Integer) —

      the index for the entity in the texture writer.

Version:

  • SketchUp 6.0

↑ #length ⇒ Integer

The #length method is used to determine the number of textures loaded into the texture writer.

The #count method is an alias for #length.

Examples:

length = tw.length
tw.load(texturable_entities[0])
if length < tw.length
  puts("A new entity was successfully loaded into the writer.")
end

Returns:

  • (Integer) —

    length - the number of textures loaded in the texture writer

Version:

  • SketchUp 6.0

↑ #load(entity) ⇒ Integer #load(face, side) ⇒ Integer

Note:

If you are passing a face in as the entity argument when loading a texture you will have to specify the second boolean argument, side. The argument side specifies which side of the face the texture will be loaded from.

The load method is used to load one or more textures into the texture writer for writing out to a file.

Examples:

index = tw.load(texturable_entities[0])
index = tw.load(faces[0], true)

Overloads:

  • #load(entity) ⇒ Integer

    Returns handle - the index or handle of the entity that was loaded.

    Parameters:

    • entity (Sketchup::Entity) —

      Image, component instance, group, or layer to load.

    Returns:

    • (Integer) —

      handle - the index or handle of the entity that was loaded

  • #load(face, side) ⇒ Integer

    Returns handle - the index or handle of the entity that was loaded.

    Parameters:

    • face (Sketchup::Face) —

      A face to load.

    • side (Boolean) —

      A boolean used to indicate the side of the face being loaded (true if front, false if back).

    Returns:

    • (Integer) —

      handle - the index or handle of the entity that was loaded

Version:

  • SketchUp 6.0

↑ #write(entity, filename) ⇒ Integer #write(entity, side, filename) ⇒ Integer

Note:

If you are passing a face in as the entity argument when writing a texture you will have to specify the boolean argument, side. The argument side controls the side of the face from which the texture will be sampled before writing it.

The write method is used to write an individual textures, within the texture writer, to a file. An entity's texture must have been loaded into the texture writer before this method can be used to write it's texture.

This method will return one of the following status messages. (These are constants that are defined by the API.)

- 0 = FILE_WRITE_OK
- 1 = FILE_WRITE_FAILED_INVALID_TIFF
- 2 = FILE_WRITE_FAILED_UNKNOWN

Examples:

tw.load(texturable_entities[0])
if tw.write(texturable_entities[0], "C:\\textures\\A.jpg") == FILE_WRITE_OK
  puts("JPEG file successfully written.")
end
tw.load(faces[0], true)
if tw.write(faces[0], true, "C:\\textures\\Face.png") == FILE_WRITE_OK
  puts("PNG file successfully written.")
end
if tw.write(faces[0], true, "C:\\textures\\Face.bmp") == FILE_WRITE_OK
  puts("BMP file successfully written.")
end
if tw.write(faces[0], true, "C:\\textures\\Face.tif") == FILE_WRITE_OK
  puts("TIFF file successfully written.")
end

Overloads:

  • #write(entity, filename) ⇒ Integer

    Returns status - one of three status messages (see comments.).

    Parameters:

    • entity (Sketchup::Entity) —

      An image, component instance, group, or layer to write.

    • filename (String) —

      The name of the file to contain the texture.

    Returns:

    • (Integer) —

      status - one of three status messages (see comments.)

  • #write(entity, side, filename) ⇒ Integer

    Returns status - one of three status messages (see comments.).

    Parameters:

    • entity (Sketchup::Entity) —

      A face to write.

    • side (Boolean) —

      A boolean used to indicate the side of the face being written (true if front, false if back).

    • filename (String) —

      The name of the file to contain the texture.

    Returns:

    • (Integer) —

      status - one of three status messages (see comments.)

Version:

  • SketchUp 6.0

↑ #write_all(dirname, filename_format) ⇒ Integer

The write_all method is used to write all of the textures within the texture writer to files. It will return one of three status numbers:

- 0 = FILE_WRITE_OK
- 1 = FILE_WRITE_FAILED_INVALID_TIFF
- 2 = FILE_WRITE_FAILED_UNKNOWN

Examples:

tw.load(texturable_entities[0]
tw.load(faces[0], false)
if tw.write_all("C:\\textures\\", true) == FILE_WRITE_OK
  puts("Texture files were successfully written.")
end

Returns status - one of three status messages (see comments.).

Parameters:

  • dirname (String) —

    The directory to write to.

  • filename_format (Boolean) —

    true to use 8.3 DOS name format.

Returns:

  • (Integer) —

    status - one of three status messages (see comments.)

Version:

  • SketchUp 6.0