view::namedFunction in std::view

Create a named view: a camera paired with the objects the view shows or hides.

Added in KCL 3.0.

A view is data, not an action. Creating one moves no camera and changes nothing about what is visible; a consumer such as the modeling app or a STEP export activates it later, which is why the same file yields the same views on every machine.

The name is display text, so it may contain spaces and punctuation. It is required, because a view is identified by the name you give it and not by the variable you bind it to, so renaming a variable never renames a view. Names are unique within one file and compared exactly, which makes Front and front two different views. Four names are rejected:

• the empty string, which identifies nothing;
• a name of nothing but whitespace, which displays as nothing;
• a name that starts or ends with whitespace, which a reader cannot see but the exact comparison above counts;
• Default View, which is reserved for the view of the scene generated on successful execution of the program.

baseline and except together decide what the view shows. You start from a clean state: baseline sets the visibility every object takes, and except lists the objects that depart from it. Every view writes its baseline out, so what a view shows can be read from the call alone:

• baseline = Visibility::Show alone: everything is visible;
• baseline = Visibility::Show with except = [a, b]: everything is visible except a and b;
• baseline = Visibility::Hide with except = [a, b]: only a and b are visible;
• baseline = Visibility::Hide alone: nothing is visible.

Duplicates in except are dropped, so listing an object twice does the same as listing it once.

Plane support

A named view can control only an independently visible plane.

Supported planes:

• A plane returned by offsetPlane() that has not been used as the support plane for a sketch.

Unsupported planes:

• The default planes:
  • XY.
  • -XY.
  • XZ.
  • -XZ.
  • YZ.
  • -YZ.
• A plane returned by offsetPlane() after it has been used as the support plane for a sketch. The executor hides that plane as sketch support.
• A plane returned by planeOf(), whether it remains unused or is used as sketch support. The engine creates it as hidden construction geometry.
• An object coerced to Plane. It describes a plane but does not have the internal properties of a plane object that can be used by a named view.

Unsupported planes are handled in two ways:

• Passing a default plane or an object coerced to Plane causes view::named() to return an error.
• Passing a planeOf() result or an offset plane used as sketch support still creates the named view. That plane is omitted when the view is activated, so listing it in except has no effect and does not reveal the construction geometry that the executor hid.

Passing a planeOf() result to offsetPlane() creates a new plane. That new result is supported if it is not subsequently used as sketch support; the original planeOf() result remains unsupported.

Arguments

Returns

NamedView - A named view: a camera paired with the set of objects it shows or hides.

Examples