|
Purpose:
|
Defines a plane as an object in the model.
|
|
|
Derivation:
|
PLANE : SURFACE : ENTITY : ACIS_OBJECT : -
|
|
|
SAT Identifier:
|
"plane"
|
|
|
Filename:
|
kern/kernel/kerndata/geom/plane.hxx
|
|
|
Description:
|
PLANE is a model geometry class that contains a pointer to a (lowercase)
plane, the corresponding construction geometry class. In general, a model geometry class is derived from
ENTITY and is used to define a permanent model object. It provides model management functionality, in addition to the geometry definition.
|
|
|
PLANE is one of several classes derived from
SURFACE to define a specific type of surface. The
plane class defines a plane by a point on the plane and its unit normal.
|
|
|
Along with the usual
SURFACE and
ENTITY class methods,
PLANE has member methods to provide access to specific implementations of the geometry. For example, methods are available to set and retrieve the root point and normal of a plane.
|
|
|
A use count allows multiple references to a
PLANE. The construction of a new
PLANE initializes the use count to 0. Methods are provided to increment and decrement the use count, and after the use count returns to 0, the entity is deleted.
|
|
|
References:
|
KERN
|
plane
|
|
|
Constructor:
|
public: PLANE::PLANE
();
|
|
|
C++ allocation constructor requests memory for this object but does not populate it. The allocation constructor is used primarily by restore. Applications should call this constructor only with the overloaded
new operator, because this reserves the memory on the heap, a requirement to support roll back and history management.
|
|
|
|
|
|
|
public: PLANE::PLANE
(
|
|
|
plane const&
|
// plane object
|
|
|
);
|
|
|
C++ copy constructor requests memory for this object and populates it with the data from the object supplied as an argument. Applications should call this constructor only with the overloaded
new operator, because this reserves the memory on the heap, a requirement to support roll back and history management.
|
|
|
|
|
|
|
public: PLANE::PLANE
(
|
|
|
SPAposition const&,
|
// position
|
|
|
SPAunit_vector const&
|
// unit vector
|
|
|
);
|
|
|
C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments. Applications should call this constructor only with the overloaded
new operator, because this reserves the memory on the heap, a requirement to support roll back and history management.
|
|
|
Makes a plane that passes through the given
SPAposition with the given
SPAunit_vector normal.
|
|
|
|
|
|
Destructor:
|
public: virtual void PLANE::lose
();
|
|
|
Posts a delete bulletin to the bulletin board indicating the instance is no longer used in the active model. The
lose methods for attached attributes are also called.
|
|
|
|
|
|
|
protected: virtual PLANE::~PLANE
();
|
|
|
This
C++ destructor should never be called directly. Instead, applications should use the overloaded
lose method inherited from the
ENTITY class, because this supports history management. (For example,
x=new PLANE(...) then later
x->lose.)
|
|
|
|
|
Methods:
|
protected: virtual logical
|
|
|
PLANE::bulletin_no_change_vf (
|
|
|
ENTITY const* other,
|
|
// other pointer
|
|
|
|
|
|
// in change bulletin
|
|
|
logical identical_comparator
|
// comparator
|
|
|
) const;
|
|
|
Compare this object with its change bulletin partner to see if the two entities are really the same.
|
|
|
|
|
|
|
public: virtual void PLANE::debug_ent
(
|
|
|
FILE*
|
// file pointer
|
|
|
) const;
|
|
|
Prints the type and address of this object, roll back pointer, attributes, and any unknown subtype information to the specified file. Refer to the
ENTITY class for more details.
|
|
|
|
|
|
|
public: surface const& PLANE::equation
() const;
|
|
|
Returns the
surface equation of the
PLANE.
|
|
|
|
|
|
|
public: surface& PLANE::equation_for_update
();
|
|
|
Returns a pointer to
surface equation for update operations. Before performing a change it checks whether the data structure is posted on the bulletin board. If not, the routine calls
backup to put an entry on the bulletin board.
|
|
|
|
|
|
|
public: virtual int PLANE::identity
(
|
|
|
int
|
|
// level
|
|
|
|
= 0
|
|
|
) const;
|
|
|
If
level is unspecified or 0, returns the type identifier
PLANE_TYPE. If
level is specified, returns
PLANE_TYPE for that level of derivation from
ENTITY. The level of this class is defined as
PLANE_LEVEL.
|
|
|
|
|
|
|
public: virtual logical PLANE::is_deepcopyable
(
|
|
|
) const;
|
|
|
Returns
TRUE if this can be deep copied.
|
|
|
|
|
|
|
public: SPAunit_vector const& PLANE::normal
() const;
|
|
|
Returns the normal defining the
PLANE.
|
|
|
|
|
|
|
public: void PLANE::operator*=
(
|
|
|
SPAtransf const&
|
// transform
|
|
|
);
|
|
|
Transforms the
PLANE. Before performing a change it checks whether the data structure is posted on the bulletin board. If not, the routine calls
backup to put an entry on the bulletin board.
|
|
|
|
|
|
|
public: void PLANE::restore_common
();
|
|
|
The
RESTORE_DEF macro expands to the
restore_common method, which is used in reading information from a SAT file. This method is never called directly. It is called by a higher hierarchical function if an item in the SAT file is determined to be of this class type. An instance of this class will already have been created through the allocation constructor. This method then populates the class instance with the appropriate data from the SAT file.
|
|
|
plane::restore_data
|
|
low-level plane geometry definition.
|
|
|
|
|
|
|
public: SPAposition const& PLANE::root_point
() const;
|
|
|
Returns the point defining the
PLANE.
|
|
|
|
|
|
|
public: void PLANE::set_normal
(
|
|
|
SPAunit_vector const&
|
// normal
|
|
|
);
|
|
|
Sets the
PLANE's normal to the given
SPAunit_vector. Before performing a change it checks whether the data structure is posted on the bulletin board. If not, the routine calls
backup to put an entry on the bulletin board.
|
|
|
|
|
|
|
public: void PLANE::set_root_point
(
|
|
|
SPAposition const&
|
// root point
|
|
|
);
|
|
|
Sets the
PLANE's root point to the given
SPAposition. Before performing a change it checks whether the data structure is posted on the bulletin board. If not, the routine calls
backup to put an entry on the bulletin board.
|
|
|
|
|
|
|
public: surface* PLANE::trans_surface
(
|
|
|
SPAtransf const&
|
|
// transform
|
|
|
|
= * (SPAtransf* ) NULL_REF,
|
|
|
logical
|
|
// reversed
|
|
|
|
= FALSE
|
|
|
) const;
|
|
|
Returns the transformed
surface equation of the
PLANE. If the logical is
TRUE, the
surface is reversed.
|
|
|
|
|
|
|
public: virtual const char*
|
|
|
PLANE::type_name () const;
|
|
|
Returns the string "plane".
|
|
|
Internal Use:
|
full_size
|
|
|
|
|
|
Related Fncs:
|
is_PLANE
|