15.3.3.7 Patch Properties

The patch properties are:

__modified__: "off" | {"on"}

alphadatamapping: "direct" | "none" | {"scaled"}

Transparency is not yet implemented for patch objects. alphadatamapping is unused.

ambientstrength: scalar, def. 0.30000

Strength of the ambient light. Value between 0.0 and 1.0

backfacelighting: "lit" | {"reverselit"} | "unlit"

"lit": The normals are used as is for lighting. "reverselit": The normals are always oriented towards the point of view. "unlit": Faces with normals pointing away from the point of view are unlit.

beingdeleted: {"off"} | "on"

busyaction: "cancel" | {"queue"}

buttondownfcn: string | function handle, def. [](0x0)

For information on how to write graphics listener functions see Callbacks section.

cdata: scalar | matrix, def. [](0x0)

Data defining the patch object color. Patch color can be defined for faces or for vertices.

If cdata is a scalar index into the current colormap or a RGB triplet, it defines the color of all faces.

If cdata is an N-by-1 vector of indices or an N-by-3 (RGB) matrix, it defines the color of each one of the N faces.

If cdata is an N-by-M or an N-by-M-by-3 (RGB) matrix, it defines the color at each vertex.

cdatamapping: "direct" | {"scaled"}

children (read-only): vector of graphics handles, def. [](0x1)

children is unused.

clipping: "off" | {"on"}

If clipping is "on", the patch is clipped in its parent axes limits.

createfcn: string | function handle, def. [](0x0)

Callback function executed immediately after patch has been created. Function is set by using default property on root object, e.g., set (0, "defaultpatchcreatefcn", 'disp ("patch created!")').

For information on how to write graphics listener functions see Callbacks section.

deletefcn: string | function handle, def. [](0x0)

Callback function executed immediately before patch is deleted.

For information on how to write graphics listener functions see Callbacks section.

diffusestrength: scalar, def. 0.60000

Strength of the diffuse reflex. Value between 0.0 (no diffuse reflex) and 1.0 (full diffuse reflex).

displayname: def. ""

Text of the legend entry corresponding to this patch.

edgealpha: scalar | matrix, def. 1

Transparency is not yet implemented for patch objects. edgealpha is unused.

edgecolor: def. [0 0 0]

edgelighting: "flat" | "gouraud" | {"none"} | "phong"

When set to a value other than "none", the edges of the object are drawn with light and shadow effects. Supported values are "none" (no lighting effects), "flat" (facetted look) and "gouraud" (linear interpolation of the lighting effects between the vertices). "phong" is deprecated and has the same effect as "gouraud".

facealpha: scalar | matrix, def. 1

Transparency is not yet implemented for patch objects. facealpha is unused.

facecolor: {colorspec} | "none" | "flat" | "interp", def. [0 0 0]

facelighting: {"flat"} | "gouraud" | "none" | "phong"

When set to a value other than "none", the faces of the object are drawn with light and shadow effects. Supported values are "none" (no lighting effects), "flat" (facetted look) and "gouraud" (linear interpolation of the lighting effects between the vertices). "phong" is deprecated and has the same effect as "gouraud".

facenormals: def. [](0x0)

facenormalsmode: {"auto"} | "manual"

faces: def. [1 2 3]

facevertexalphadata: scalar | matrix, def. [](0x0)

Transparency is not yet implemented for patch objects. facevertexalphadata is unused.

facevertexcdata: def. [](0x0)

handlevisibility: "callback" | "off" | {"on"}

If handlevisibility is "off", the patch’s handle is not visible in its parent’s "children" property.

hittest: "off" | {"on"}

interpreter: "latex" | "none" | {"tex"}

interpreter is unused.

interruptible: "off" | {"on"}

linestyle: {"-"} | "--" | "-." | ":" | "none"

linewidth: def. 0.50000

marker: "*" | "+" | "." | "<" | ">" | "^" | "d" | "diamond" | "h" | "hexagram" | {"none"} | "o" | "p" | "pentagram" | "s" | "square" | "v" | "x"

See line marker property.

markeredgecolor: {"auto"} | "flat" | "none"

See line markeredgecolor property.

markerfacecolor: "auto" | "flat" | {"none"}

See line markerfacecolor property.

markersize: scalar, def. 6

See line markersize property.

parent: graphics handle

Handle of the parent graphics object.

selected: {"off"} | "on"

selectionhighlight: "off" | {"on"}

specularcolorreflectance: scalar, def. 1

Reflectance for specular color. Value between 0.0 (color of underlying face) and 1.0 (color of light source).

specularexponent: scalar, def. 10

Exponent for the specular reflex. The lower the value, the more the reflex is spread out.

specularstrength: scalar, def. 0.90000

Strength of the specular reflex. Value between 0.0 (no specular reflex) and 1.0 (full specular reflex).

tag: string, def. ""

A user-defined string to label the graphics object.

type (read-only): string

Class name of the graphics object. type is always "patch"

uicontextmenu: graphics handle, def. [](0x0)

Graphics handle of the uicontextmenu object that is currently associated to this patch object.

userdata: Any Octave data, def. [](0x0)

User-defined data to associate with the graphics object.

vertexnormals: def. [](0x0)

vertexnormalsmode: {"auto"} | "manual"

vertices: vector | matrix, def. 3-by-2 double

visible: "off" | {"on"}

If visible is "off", the patch is not rendered on screen.

xdata: vector | matrix, def. [0; 1; 0]

ydata: vector | matrix, def. [1; 1; 0]

zdata: vector | matrix, def. [](0x0)